'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Ram',
'version' => '2015-05-01',
],
'directories' => [
[
'id' => 67227,
'title' => '用户管理',
'type' => 'directory',
'children' => [
[
'id' => 186630,
'title' => '用户',
'type' => 'directory',
'children' => [
'CreateUser',
'GetUser',
'UpdateUser',
'DeleteUser',
'ListUsers',
],
],
[
'id' => 186631,
'title' => '登录信息',
'type' => 'directory',
'children' => [
'CreateLoginProfile',
'GetLoginProfile',
'UpdateLoginProfile',
'DeleteLoginProfile',
'ChangePassword',
],
],
[
'id' => 186632,
'title' => '访问密钥',
'type' => 'directory',
'children' => [
'CreateAccessKey',
'UpdateAccessKey',
'DeleteAccessKey',
'ListAccessKeys',
'GetAccessKeyLastUsed',
],
],
[
'id' => 186633,
'title' => '多因素认证',
'type' => 'directory',
'children' => [
'CreateVirtualMFADevice',
'GetUserMFAInfo',
'DeleteVirtualMFADevice',
'ListVirtualMFADevices',
'BindMFADevice',
'UnbindMFADevice',
],
],
],
],
[
'id' => 67248,
'title' => '用户组管理',
'type' => 'directory',
'children' => [
'CreateGroup',
'GetGroup',
'UpdateGroup',
'DeleteGroup',
'ListGroups',
'ListGroupsForUser',
'ListUsersForGroup',
'AddUserToGroup',
'RemoveUserFromGroup',
],
],
[
'id' => 67221,
'title' => '角色管理',
'type' => 'directory',
'children' => [
'CreateRole',
'DeleteRole',
'UpdateRole',
'GetRole',
'ListRoles',
],
],
[
'id' => 67201,
'title' => '权限管理',
'type' => 'directory',
'children' => [
[
'id' => 186634,
'title' => '权限策略管理',
'type' => 'directory',
'children' => [
'CreatePolicy',
'GetPolicy',
'UpdatePolicyDescription',
'DeletePolicy',
'ListPolicies',
'CreatePolicyVersion',
'GetPolicyVersion',
'DeletePolicyVersion',
'ListPolicyVersions',
'SetDefaultPolicyVersion',
],
],
[
'id' => 186635,
'title' => '授权管理',
'type' => 'directory',
'children' => [
'AttachPolicyToUser',
'DetachPolicyFromUser',
'AttachPolicyToGroup',
'DetachPolicyFromGroup',
'AttachPolicyToRole',
'DetachPolicyFromRole',
'ListPoliciesForUser',
'ListPoliciesForGroup',
'ListPoliciesForRole',
'ListEntitiesForPolicy',
],
],
],
],
[
'id' => 67192,
'title' => '安全设置',
'type' => 'directory',
'children' => [
'SetAccountAlias',
'GetAccountAlias',
'ClearAccountAlias',
'SetPasswordPolicy',
'GetPasswordPolicy',
'SetSecurityPreference',
'GetSecurityPreference',
],
],
[
'id' => 183186,
'title' => '权限分析与诊断',
'type' => 'directory',
'children' => [
'DecodeDiagnosticMessage',
],
],
[
'id' => 206934,
'title' => '标签管理',
'type' => 'directory',
'children' => [
'TagResources',
'UntagResources',
'ListTagResources',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'alice',
],
],
[
'name' => 'DisplayName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的显示名称。'."\n"
."\n"
.'长度为1~128个字符。',
'type' => 'string',
'required' => false,
'example' => 'alice',
],
],
[
'name' => 'MobilePhone',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的手机号码。'."\n"
."\n"
.'格式:国际区号-号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。'."\n",
'type' => 'string',
'required' => false,
'example' => '86-1868888****',
],
],
[
'name' => 'Email',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的电子邮箱。'."\n"
."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'required' => false,
'example' => 'alice@example.com',
],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => [
'description' => '备注。'."\n"
."\n"
.'长度为1~128个字符。',
'type' => 'string',
'required' => false,
'example' => 'This is a cloud computing engineer.',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => 'RAM用户的显示名称。',
'type' => 'string',
'example' => 'alice',
],
'Email' => [
'description' => 'RAM用户的电子邮箱。'."\n"
."\n"
.'> 该参数仅适用于中国站。'."\n",
'type' => 'string',
'example' => 'alice@example.com',
],
'MobilePhone' => [
'description' => 'RAM用户的手机号码。'."\n"
.'> 该参数仅适用于中国站。',
'type' => 'string',
'example' => '86-1868888****',
],
'UserId' => [
'description' => 'RAM用户的唯一标识。',
'type' => 'string',
'example' => '122748924538****',
],
'Comments' => [
'description' => '备注。',
'type' => 'string',
'example' => 'This is a cloud computing engineer.',
],
'CreateDate' => [
'description' => 'RAM用户的创建时间(UTC时间)。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => 'RAM用户的名称。',
'type' => 'string',
'example' => 'alice',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"DisplayName\\": \\"alice\\",\\n \\"Email\\": \\"alice@example.com\\",\\n \\"MobilePhone\\": \\"86-1868888****\\",\\n \\"UserId\\": \\"122748924538****\\",\\n \\"Comments\\": \\"This is a cloud computing engineer.\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"alice\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 122748924538****\\n alice\\n alice\\n 86-1868888****\\n alice@example.com\\n This is a cloud computing engineer.\\n 2015-01-23T12:33:18Z\\n \\n","errorExample":""}]',
'title' => '创建RAM用户',
'summary' => '调用CreateUser接口创建RAM用户。',
'description' => '本文将提供一个示例,创建一个名为`alice`的RAM用户。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => "\n"
.' 成功创建RAM用户后,您可以进行以下的后续操作:'."\n"
."\n"
.'- 调用CreateLoginProfile接口为RAM用户启用Web控制台登录,可以配置登录密码等信息。更多信息,请参见[CreateLoginProfile](~~28685~~)。'."\n"
.'- 调用CreateAccessKey接口为RAM用户创建访问密钥。更多信息,请参见[CreateAccessKey](~~28689~~)。'."\n"
."\n\n",
],
'GetUser' => [
'summary' => '调用GetUser接口查询RAM用户的详细信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'alice',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '显示名称。',
'type' => 'string',
'example' => 'alice',
],
'Email' => [
'description' => 'RAM用户的电子邮箱。'."\n"
.'> 该参数仅适用于中国站。 ',
'type' => 'string',
'example' => 'alice@example.com',
],
'UpdateDate' => [
'description' => 'RAM用户的更新时间(UTC时间)。',
'type' => 'string',
'example' => '2015-02-11T03:15:21Z',
],
'MobilePhone' => [
'description' => 'RAM用户的手机号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。 ',
'type' => 'string',
'example' => '86-1860000****',
],
'UserId' => [
'description' => 'RAM用户的唯一标识。',
'type' => 'string',
'example' => '222748924538****',
],
'Comments' => [
'description' => '备注。',
'type' => 'string',
'example' => '这是一位云计算工程师',
],
'LastLoginDate' => [
'description' => '上次使用密码登录时间(UTC时间)。'."\n",
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'CreateDate' => [
'description' => 'RAM用户的创建时间(UTC时间)。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => 'RAM用户的名称。',
'type' => 'string',
'example' => 'alice',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2D69A58F-345C-4FDE-88E4-BF5189484043',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"DisplayName\\": \\"alice\\",\\n \\"Email\\": \\"alice@example.com\\",\\n \\"UpdateDate\\": \\"2015-02-11T03:15:21Z\\",\\n \\"MobilePhone\\": \\"86-1860000****\\",\\n \\"UserId\\": \\"222748924538****\\",\\n \\"Comments\\": \\"这是一位云计算工程师\\",\\n \\"LastLoginDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"alice\\"\\n },\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF5189484043\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2D69A58F-345C-4FDE-88E4-BF5189484043\\n \\n 222748924538****\\n alice\\n alice\\n 86-1860000****\\n alice@example.com\\n This is a cloud computing engineer.\\n 2015-01-23T12:33:18Z\\n 2015-02-11T03:15:21Z\\n 2015-01-23T12:33:18Z\\n \\n","errorExample":""}]',
'title' => '查询RAM用户的详细信息',
'description' => '本文将提供一个示例,查询RAM用户`alice`的详细信息。 ',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
[
'name' => 'NewUserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的新名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'xiaoq****',
],
],
[
'name' => 'NewDisplayName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的新显示名称。'."\n"
."\n"
.'长度为1~128个字符。',
'type' => 'string',
'required' => false,
'example' => 'xiaoq****',
],
],
[
'name' => 'NewMobilePhone',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的新手机号码。'."\n"
."\n"
.'格式:国际区号-号码。'."\n"
."\n"
.'> 该参数仅适用于中国站。 '."\n",
'type' => 'string',
'required' => false,
'example' => '86-1860000****',
],
],
[
'name' => 'NewEmail',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的新电子邮箱。'."\n"
."\n"
.'> 该参数仅适用于中国站。 ',
'type' => 'string',
'required' => false,
'example' => 'xiaoq****@example.com',
],
],
[
'name' => 'NewComments',
'in' => 'query',
'schema' => [
'description' => '新备注。'."\n"
."\n"
.'长度为1~128个字符。',
'type' => 'string',
'required' => false,
'example' => 'This is a cloud computing engineer.',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'User' => [
'description' => 'RAM用户信息。'."\n",
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => 'RAM用户的显示名称。',
'type' => 'string',
'example' => 'xiaoq****',
],
'Email' => [
'description' => 'RAM用户的电子邮箱。'."\n"
.'> 该参数仅适用于中国站。 ',
'type' => 'string',
'example' => 'xiaoq****@example.com',
],
'UpdateDate' => [
'description' => 'RAM用户的更新时间(UTC时间)。',
'type' => 'string',
'example' => '2015-02-11T03:15:21Z',
],
'MobilePhone' => [
'description' => 'RAM用户的手机号码。'."\n"
.'> 该参数仅适用于中国站。 ',
'type' => 'string',
'example' => '86-1860000****',
],
'UserId' => [
'description' => 'RAM用户的唯一标识。',
'type' => 'string',
'example' => '122748924538****',
],
'Comments' => [
'description' => '备注。',
'type' => 'string',
'example' => 'This is a cloud computing engineer.',
],
'CreateDate' => [
'description' => 'RAM用户的创建时间(UTC时间)。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => 'RAM用户的名称。',
'type' => 'string',
'example' => 'xiaoq****',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"User\\": {\\n \\"DisplayName\\": \\"xiaoq****\\",\\n \\"Email\\": \\"xiaoq****@example.com\\",\\n \\"UpdateDate\\": \\"2015-02-11T03:15:21Z\\",\\n \\"MobilePhone\\": \\"86-1860000****\\",\\n \\"UserId\\": \\"122748924538****\\",\\n \\"Comments\\": \\"This is a cloud computing engineer.\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"xiaoq****\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 122748924538****\\n xiaoq****\\n xiaoq*****\\n 86-1860000****\\n xiaoq****@example.com\\n This is a cloud computing engineer.\\n 2015-01-23T12:33:18Z\\n 2015-02-11T03:15:21Z\\n \\n","errorExample":""}]',
'title' => '更新RAM用户的基本信息',
'summary' => '调用UpdateUser接口更新RAM用户的基本信息。',
'description' => '本文将提供一个示例,将RAM用户的名称由`zhangq****`修改为`xiaoq****`。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)、短划线(-)和下划线(_)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}"},{"type":"xml","example":"1C488B66-B819-4D14-8711-C4EAAA13AC01","errorExample":"\\n 1C488B66-B819-4D14-8711-C4EAAA13AC01\\n"}]',
'title' => '删除一个RAM用户',
'summary' => '调用DeleteUser接口删除一个RAM用户。',
'description' => '删除用户前,需要保证用户不拥有任何权限且不属于任何用户组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListUsers' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => [
'description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。',
'type' => 'string',
'required' => false,
'example' => 'EXAMPLE',
],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => [
'description' => '返回结果的条数,当返回结果达到MaxItems限制被截断时,返回参数`IsTruncated`将等于`true`。'."\n"
."\n"
.'取值范围:1~1000。默认值:100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E',
],
'IsTruncated' => [
'description' => '请求返回结果是否被截断。',
'type' => 'boolean',
'example' => 'true',
],
'Marker' => [
'description' => '当`IsTruncated`为`true`时才有此字段,当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容 。',
'type' => 'string',
'example' => 'EXAMPLE',
],
'Users' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => 'RAM用户列表。',
'type' => 'array',
'items' => [
'description' => 'RAM用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => 'RAM用户的显示名称。',
'type' => 'string',
'example' => '张*',
],
'Email' => [
'description' => 'RAM用户邮箱。'."\n"
."\n"
.'> 暂不提供该参数。',
'type' => 'string',
'example' => 'zhangq****@example.com',
],
'UpdateDate' => [
'description' => 'RAM用户的更新时间(UTC时间)。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'MobilePhone' => [
'description' => 'RAM用户手机号码。'."\n"
."\n"
.'> 暂不提供该参数。 ',
'type' => 'string',
'example' => '86-1860000****',
],
'UserId' => [
'description' => 'RAM用户ID。',
'type' => 'string',
'example' => '20732900249392****',
],
'Comments' => [
'description' => '备注。'."\n",
'type' => 'string',
'example' => '这是一位云计算工程师',
],
'CreateDate' => [
'description' => 'RAM用户的创建时间(UTC时间)。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => 'RAM用户的登录名称。',
'type' => 'string',
'example' => 'zhangq****',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"张*\\",\\n \\"Email\\": \\"zhangq****@example.com\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"MobilePhone\\": \\"86-1860000****\\",\\n \\"UserId\\": \\"20732900249392****\\",\\n \\"Comments\\": \\"这是一位云计算工程师\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"zhangq****\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\" : \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Users\\" : {\\n \\"User\\" : [\\n {\\n \\"UserId\\" : \\"1227489245380721\\",\\n \\"UserName\\" : \\"zhangqiang\\",\\n \\"DisplayName\\": \\"张强\\",\\n \\"MobilePhone\\": \\"86-18600008888\\",\\n \\"Email\\": \\"zhangqiang@example.com\\",\\n \\"Comments\\": \\"这是一位云计算工程师\\",\\n \\"CreateDate\\" : \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\" : \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"UserId\\" : \\"1406498224724456\\",\\n \\"UserName\\" : \\"lili\\",\\n \\"DisplayName\\": \\"李丽\\",\\n \\"MobilePhone\\": \\"86-18600009999\\",\\n \\"Email\\": \\"lili@example.com\\",\\n \\"Comments\\": \\"权限管理员\\",\\n \\"CreateDate\\" : \\"2015-02-18T17:22:08Z\\",\\n \\"UpdateDate\\" : \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\r\\n\\r\\n\\t4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\r\\n\\ttrue\\r\\n\\tEXAMPLE\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t122748924538****\\r\\n\\t\\t\\tzhangq****\\r\\n\\t\\t\\t张*\\r\\n\\t\\t\\t这是一位云计算工程师\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t140649822472****\\r\\n\\t\\t\\tli****\\r\\n\\t\\t\\t李*\\r\\n\\t\\t\\t权限管理员\\r\\n\\t\\t\\t2015-02-18T17:22:08Z\\r\\n\\t\\t\\t2015-02-18T17:22:08Z\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":"\\n 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\n \\n \\n 1227489245380721\\n zhangqiang\\n 张强\\n 86-18600008888\\n zhangqiang@example.com\\n 这是一位云计算工程师\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n \\n 1406498224724456\\n lili\\n 李丽\\n 86-18600009999\\n lili@example.com\\n 权限管理员\\n 2015-02-18T17:22:08Z\\n 2015-02-18T17:22:08Z\\n \\n \\n true\\n EXAMPLE\\n"}]',
'title' => '查询所有RAM用户',
'summary' => '查询所有RAM用户的详细信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateLoginProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => [
'description' => '指定密码,密码必须符合密码强度要求。关于密码强度设置要求,请参见[GetPasswordPolicy](~~2337691~~)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'mypassword',
],
],
[
'name' => 'PasswordResetRequired',
'in' => 'query',
'schema' => [
'description' => '指定用户在登录时是否需要修改密码。默认为`false`。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'MFABindRequired',
'in' => 'query',
'schema' => [
'description' => '指定用户在下次登录时是否必须绑定多因素认证器。默认为`false`。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'LoginProfile' => [
'description' => '登录配置信息。',
'type' => 'object',
'properties' => [
'PasswordResetRequired' => [
'description' => '要求下次登录时重设密码。',
'type' => 'boolean',
'example' => 'false',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => '用户名。',
'type' => 'string',
'example' => 'zhangq****',
],
'MFABindRequired' => [
'description' => '要求必须绑定多因素认证设备。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"LoginProfile\\": {\\n \\"PasswordResetRequired\\": false,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"zhangq****\\",\\n \\"MFABindRequired\\": false\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"LoginProfile\\": {\\n \\"UserName\\": \\"zhangqiang\\",\\n \\"PasswordResetRequired\\": true,\\n \\"MFABindRequired\\": true,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368\\n\\n zhangq****\\n true\\n true\\n 2015-01-23T12:33:18Z\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n zhangqiang\\n true\\n true\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '为一个RAM用户启用Web控制台登录',
'summary' => '调用CreateLoginProfile接口为一个RAM用户启用Web控制台登录。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetLoginProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'LoginProfile' => [
'description' => '登录配置信息。',
'type' => 'object',
'properties' => [
'PasswordResetRequired' => [
'description' => '要求下次登录时重设密码。',
'type' => 'boolean',
'example' => 'true',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => '用户名。',
'type' => 'string',
'example' => 'zhangq****',
],
'MFABindRequired' => [
'description' => '要求必须绑定多因素认证设备。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"LoginProfile\\": {\\n \\"PasswordResetRequired\\": true,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"zhangq****\\",\\n \\"MFABindRequired\\": true\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"LoginProfile\\": {\\n \\"UserName\\": \\"zhangqiang\\",\\n \\"PasswordResetRequired\\": true,\\n \\"MFABindRequired\\": true,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368\\n\\n zhangq****\\n true\\n true\\n 2015-01-23T12:33:18Z\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n zhangqiang\\n true\\n true\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '查看一个RAM用户的登录配置',
'summary' => '调用GetLoginProfile接口查看一个RAM用户的登录配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateLoginProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => [
'description' => '指定密码,密码必须符合云账号的密码强度要求。',
'type' => 'string',
'required' => false,
'example' => 'mypassword',
],
],
[
'name' => 'PasswordResetRequired',
'in' => 'query',
'schema' => [
'description' => '指定用户在登录时是否需要修改密码。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'MFABindRequired',
'in' => 'query',
'schema' => [
'description' => '指定用户在下次登录时是否必须绑定多因素认证设备。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '修改用户的登录配置',
'summary' => '调用UpdateLoginProfile接口修改用户的登录配置。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteLoginProfile' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1C488B66-B819-4D14-8711-C4EAAA13AC01',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"1C488B66-B819-4D14-8711-C4EAAA13AC01\\"\\n}"},{"type":"xml","example":"1C488B66-B819-4D14-8711-C4EAAA13AC01","errorExample":"\\n 1C488B66-B819-4D14-8711-C4EAAA13AC01\\n"}]',
'title' => '关闭RAM用户登录Web控制台功能',
'summary' => '关闭指定RAM用户登录Web控制台的功能。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ChangePassword' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '7517',
'abilityTreeNodes' => [
'FEATUREram8R8C7X',
],
],
'parameters' => [
[
'name' => 'OldPassword',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的控制台登录旧密码。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '12****',
],
],
[
'name' => 'NewPassword',
'in' => 'query',
'schema' => [
'description' => 'RAM用户的控制台登录新密码。'."\n"
."\n"
.'密码必须符合密码强度要求。更多信息,请参见[SetPasswordPolicy](~~28739~~)。 ',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'aw$2****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '修改RAM用户密码',
'summary' => 'RAM用户调用ChangePassword修改自己的控制台登录密码。',
'description' => '> 该API仅限RAM用户调用。调用前,请确保已将[SetSecurityPreference](~~43765~~)中的`AllowUserToChangePassword`设置为`True`,即允许RAM用户自主管理密码。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateAccessKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名,RAM用户调用此接口时,默认为自己创建访问密钥。',
'type' => 'string',
'required' => false,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'AccessKey' => [
'description' => '访问密钥。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态,激活或禁用。',
'type' => 'string',
'example' => 'Active',
],
'AccessKeySecret' => [
'description' => '访问密钥。',
'type' => 'string',
'example' => 'PupkTg8jdmau1cXxYacgE736PJ****',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'AccessKeyId' => [
'description' => '访问密钥标识。',
'type' => 'string',
'example' => '0wNEpMMlzy7s****',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AccessKey\\": {\\n \\"Status\\": \\"Active\\",\\n \\"AccessKeySecret\\": \\"PupkTg8jdmau1cXxYacgE736PJ****\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AccessKeyId\\": \\"0wNEpMMlzy7s****\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AccessKey\\": {\\n \\"AccessKeyId\\": \\"0wNEpMMlzy7szvai\\",\\n \\"AccessKeySecret\\": \\"PupkTg8jdmau1cXxYacgE736PJj4cA\\",\\n \\"Status\\": \\"Active\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368\\n\\n 0wNEpMMlzy7s****\\n PupkTg8jdmau1cXxYacgE736PJ****\\n Active\\n 2015-01-23T12:33:18Z\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 0wNEpMMlzy7szvai\\n PupkTg8jdmau1cXxYacgE736PJj4cA\\n Active\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '为RAM用户创建访问密钥',
'summary' => '调用CreateAccessKey接口为RAM用户创建访问密钥。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateAccessKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'example' => 'zhangq****',
],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => [
'description' => '指定要更新的`AccessKeyId`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '0wNEpMMlzy7s****',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => 'AccessKey的状态,取值为`Active`或`Inactive`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Inactive',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '更新RAM用户访问密钥的状态',
'summary' => '调用UpdateAccessKey接口更新RAM用户访问密钥的状态。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteAccessKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'example' => 'zhangq****',
],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => [
'description' => '指定要删除的`AccessKeyId`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '0wNEpMMlzy7s****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '删除RAM用户的访问密钥',
'summary' => '调用DeleteAccessKey接口删除RAM用户的访问密钥。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListAccessKeys' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户,RAM用户访问时不提供此参数则表示列出自己的访问密钥。',
'type' => 'string',
'required' => false,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'AccessKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AccessKey' => [
'description' => '用户信息集合。',
'type' => 'array',
'items' => [
'description' => '用户信息集合。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '状态,激活或禁用。',
'type' => 'string',
'example' => 'Active',
],
'AccessKeyId' => [
'description' => '访问密钥标识。',
'type' => 'string',
'example' => '0wNEpMMlzy7s****',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKeys\\": {\\n \\"AccessKey\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"AccessKeyId\\": \\"0wNEpMMlzy7s****\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\"\\n}","errorExample":"{\\n \\"RequestId\\" : \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"AccessKeys\\":{\\n \\"AccessKey\\":[\\n {\\n \\"AccessKeyId\\": \\"0wNEpMMlzy7szvai\\",\\n \\"Status\\": \\"Active\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"AccessKeyId\\": \\"WnIWUruvfaDT37vQ\\",\\n \\"Status\\": \\"Inactive\\",\\n \\"CreateDate\\": \\"2015-03-24T21:12:21Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\n\\n \\n 0wNEpMMlzy7s****\\n Active\\n 2015-01-23T12:33:18Z\\n \\n \\n WnIWUruvfaDT****\\n Inactive\\n 2015-03-24T21:12:21Z\\n \\n","errorExample":"\\n 4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\n \\n \\n 0wNEpMMlzy7szvai\\n Active\\n 2015-01-23T12:33:18Z\\n \\n \\n WnIWUruvfaDT37vQ\\n Inactive\\n 2015-03-24T21:12:21Z\\n \\n \\n"}]',
'title' => '列出指定用户的访问密钥',
'summary' => '调用ListAccessKeys接口列出指定用户的访问密钥。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetAccessKeyLastUsed' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户名称。',
'type' => 'string',
'required' => false,
'example' => 'test',
],
],
[
'name' => 'UserAccessKeyId',
'in' => 'query',
'schema' => [
'description' => '需要查询的访问密钥ID。',
'type' => 'string',
'required' => false,
'example' => 'LTAI4GFTgcR8m8cZQDTH****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessKeyLastUsed' => [
'description' => '访问密钥的最后使用信息。',
'type' => 'object',
'properties' => [
'LastUsedDate' => [
'description' => '最后使用时间。',
'type' => 'string',
'example' => '2020-10-21T06:37:40Z',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '5CCE804C-6450-49A7-B1DB-2460F7A97416',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessKeyLastUsed\\": {\\n \\"LastUsedDate\\": \\"2020-10-21T06:37:40Z\\"\\n },\\n \\"RequestId\\": \\"5CCE804C-6450-49A7-B1DB-2460F7A97416\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t2020-10-21T06:37:40Z\\r\\n\\t\\r\\n\\t5CCE804C-6450-49A7-B1DB-2460F7A97416\\r\\n\\r\\n","errorExample":""}]',
'title' => '查询指定访问密钥的最后使用时间',
'summary' => '调用GetAccessKeyLastUsed查询指定访问密钥的最后使用时间',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateVirtualMFADevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'VirtualMFADeviceName',
'in' => 'query',
'schema' => [
'description' => '多因素认证设备名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)和短划线(-)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'device001',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'VirtualMFADevice' => [
'description' => '多因素认证设备。',
'type' => 'object',
'properties' => [
'SerialNumber' => [
'description' => '设备序列号。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:mfa/device001',
],
'QRCodePNG' => [
'description' => '密钥二维码PNG,使用Base64编码。',
'type' => 'string',
'example' => 'YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****',
],
'Base32StringSeed' => [
'description' => '多因素认证设备密钥。',
'type' => 'string',
'example' => 'DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGS****',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"VirtualMFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::123456789012****:mfa/device001\\",\\n \\"QRCodePNG\\": \\"YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****\\",\\n \\"Base32StringSeed\\": \\"DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGS****\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"VirtualMFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::1234567890123:mfa/device001\\",\\n \\"Base32StringSeed\\": \\"DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGSD7A8\\",\\n \\"QRCodePNG\\": \\"YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEzdCAg\\"\\n }\\n}"},{"type":"xml","example":"\\n\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\n\\t\\n\\t\\tacs:ram::123456789012****:mfa/device001\\n\\t\\tDSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGS****\\n\\t\\tYXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEz****\\n\\t\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n acs:ram::1234567890123:mfa/device001\\n DSF98HAD982KJA9SDFNAS9D8FU839B8ADHBGSD7A8\\n YXNkZmFzZDlmeW5hc2Q5OGZoODd4bXJmcThhaGU5aSBmYXNkZiBzYWRmIGFGIDRxd2VjIGEgdHEzdCAg\\n \\n"}]',
'title' => '创建多因素认证设备',
'summary' => '调用CreateVirtualMFADevice接口创建多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetUserMFAInfo' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'test',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'MFADevice' => [
'description' => 'MFA设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => [
'description' => '设备序列号。',
'type' => 'string',
'example' => 'acs:ram::177242285274****:mfa/test',
],
'Type' => [
'description' => '多因素认证设备类型。取值:'."\n"
."\n"
.'- VMFA:虚拟MFA设备。'."\n"
.'- U2F:U2F安全密钥。',
'type' => 'string',
'example' => 'VMFA',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::177242285274****:mfa/test\\",\\n \\"Type\\": \\"VMFA\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"MFADevice\\": {\\n \\"SerialNumber\\":\\"Virtual-MFA-device002\\"\\n }\\n}"},{"type":"xml","example":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\tacs:ram::177242285274****:mfa/test\\r\\n\\t\\tVMFA\\r\\n\\t\\r\\n\\t\\r\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n Virtual-MFA-device002\\n \\n"}]',
'title' => '获取多因素认证设备信息',
'summary' => '获取指定RAM用户的多因素认证设备信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteVirtualMFADevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => [
'description' => '指定多因素认证设备的序列号。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'acs:ram::123456789012****:mfa/device002',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '删除多因素认证设备',
'summary' => '调用DeleteVirtualMFADevice接口删除多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListVirtualMFADevices' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'VirtualMFADevices' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VirtualMFADevice' => [
'description' => '多因素认证设备列表。',
'type' => 'array',
'items' => [
'description' => '多因素认证设备列表。',
'type' => 'object',
'properties' => [
'SerialNumber' => [
'description' => '多因素认证设备序列号。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:mfa/device002',
],
'User' => [
'description' => '绑定用户的基本信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '显示名称。',
'type' => 'string',
'example' => '张*',
],
'UserId' => [
'description' => '用户唯一标识。',
'type' => 'string',
'example' => '122748924538****',
],
'UserName' => [
'description' => '用户名称。',
'type' => 'string',
'example' => 'zhangq****',
],
],
],
'ActivateDate' => [
'description' => '激活日期。',
'type' => 'string',
'example' => '2015-02-18T17:22:08Z',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"VirtualMFADevices\\": {\\n \\"VirtualMFADevice\\": [\\n {\\n \\"SerialNumber\\": \\"acs:ram::123456789012****:mfa/device002\\",\\n \\"User\\": {\\n \\"DisplayName\\": \\"张*\\",\\n \\"UserId\\": \\"122748924538****\\",\\n \\"UserName\\": \\"zhangq****\\"\\n },\\n \\"ActivateDate\\": \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"VirtualMFADevices\\": {\\n \\"VirtualMFADevice\\": [\\n {\\n \\"SerialNumber\\": \\"acs:ram::1234567890123:mfa/device001\\"\\n },\\n {\\n \\"SerialNumber\\": \\"acs:ram::1234567890123:mfa/device002\\",\\n \\"ActivateDate\\": \\"2015-02-18T17:22:08Z\\",\\n \\"User\\": {\\n \\"UserId\\": \\"1227489245380721\\",\\n \\"UserName\\": \\"zhangqiang\\",\\n \\"DisplayName\\": \\"张强\\"\\n }\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368\\n\\n \\n acs:ram::123456789012****:mfa/device001\\n \\n \\n acs:ram::123456789012****:mfa/device002\\n 2015-02-18T17:22:08Z\\n \\n 122748924538****\\n zhangq****\\n 张*\\n \\n \\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n \\n acs:ram::1234567890123:mfa/device001\\n \\n \\n acs:ram::1234567890123:mfa/device002\\n 2015-02-18T17:22:08Z\\n \\n 1227489245380721\\n zhangqiang\\n 张强\\n \\n \\n \\n"}]',
'title' => '列出多因素认证设备',
'summary' => '调用ListVirtualMFADevices接口列出多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'BindMFADevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [],
'parameters' => [
[
'name' => 'SerialNumber',
'in' => 'query',
'schema' => [
'description' => '指定多因素认证设备的序列号。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'acs:ram::123456789012****:mfa/device002',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
[
'name' => 'AuthenticationCode1',
'in' => 'query',
'schema' => [
'description' => '验证第一组动态密码。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '11****',
],
],
[
'name' => 'AuthenticationCode2',
'in' => 'query',
'schema' => [
'description' => '验证第二组动态密码。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '33****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '绑定多因素认证设备',
'summary' => '调用BindMFADevice接口绑定多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UnbindMFADevice' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'MFADevice' => [
'description' => '多因素认证设备信息。',
'type' => 'object',
'properties' => [
'SerialNumber' => [
'description' => '设备序列号。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:mfa/device002',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"MFADevice\\": {\\n \\"SerialNumber\\": \\"acs:ram::123456789012****:mfa/device002\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"MFADevice\\": {\\n \\"SerialNumber\\":\\"acs:ram::1234567890123:mfa/device002\\"\\n }\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368\\n\\n acs:ram::123456789012****:mfa/device002\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n acs:ram::1234567890123:mfa/device002\\n \\n"}]',
'title' => '解绑多因素认证设备',
'summary' => '调用UnbindMFADevice接口解绑多因素认证设备。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、英文句点(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => [
'description' => '备注信息。'."\n"
."\n"
.'最大长度128个字符。',
'type' => 'string',
'required' => false,
'example' => '开发团队',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'GroupId' => [
'description' => '用户组ID。',
'type' => 'string',
'example' => 'g-FpMEHiMysofp****',
],
'GroupName' => [
'description' => '用户组名称。',
'type' => 'string',
'example' => 'Dev-Team',
],
'Comments' => [
'description' => '备注信息。',
'type' => 'string',
'example' => '开发团队',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D3F0679E-9757-95DB-AF2D-04D5188C69C5',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Group\\": {\\n \\"GroupId\\": \\"g-FpMEHiMysofp****\\",\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n \\"RequestId\\": \\"D3F0679E-9757-95DB-AF2D-04D5188C69C5\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D3F0679E-9757-95DB-AF2D-04D5188C69C5\\",\\n \\"Group\\": {\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"\\n\\n\\tD3F0679E-9757-95DB-AF2D-04D5188C69C5\\n\\t\\n\\t\\tDev-Team\\n\\t\\t开发团队\\n\\t\\t2015-01-23T12:33:18Z\\n g-FpMEHiMysofp****\\n\\t\\n","errorExample":"\\n D3F0679E-9757-95DB-AF2D-04D5188C69C5\\n \\n Dev-Team\\n 开发团队\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '创建用户组',
'summary' => '调用CreateGroup接口创建用户组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'GroupId' => [
'description' => '用户组ID。',
'type' => 'string',
'example' => 'g-FpMEHiMysofp****',
],
'UpdateDate' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2015-02-11T03:15:21Z',
],
'GroupName' => [
'description' => '用户组名称。',
'type' => 'string',
'example' => 'Dev-Team',
],
'Comments' => [
'description' => '备注信息。',
'type' => 'string',
'example' => '开发团队',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D4065824-E422-3ED6-68B1-1AF7D5C7804C',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Group\\": {\\n \\"GroupId\\": \\"g-FpMEHiMysofp****\\",\\n \\"UpdateDate\\": \\"2015-02-11T03:15:21Z\\",\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n \\"RequestId\\": \\"D4065824-E422-3ED6-68B1-1AF7D5C7804C\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"D4065824-E422-3ED6-68B1-1AF7D5C7804C\\",\\n \\"Group\\": {\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-02-11T03:15:21Z\\"\\n }\\n}"},{"type":"xml","example":"\\n\\n\\tD4065824-E422-3ED6-68B1-1AF7D5C7804C\\n\\t\\n\\t\\tDev-Team\\n\\t\\t开发团队\\n\\t\\t2015-01-23T12:33:18Z\\n\\t\\t2015-02-11T03:15:21Z\\n g-FpMEHiMysofp****\\n\\t\\n\\t\\n","errorExample":"\\n D4065824-E422-3ED6-68B1-1AF7D5C7804C\\n \\n Dev-Team\\n 开发团队\\n 2015-01-23T12:33:18Z\\n 2015-02-11T03:15:21Z\\n \\n"}]',
'title' => '查询用户组信息',
'summary' => '调用GetGroup接口查询用户组信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
[
'name' => 'NewGroupName',
'in' => 'query',
'schema' => [
'description' => '新的用户组名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、英文句点(.)、下划线(_)和短划线(-)。',
'type' => 'string',
'required' => false,
'example' => 'NewDev-Team',
],
],
[
'name' => 'NewComments',
'in' => 'query',
'schema' => [
'description' => '新的备注信息。'."\n"
."\n"
.'长度为1~128个字符。',
'type' => 'string',
'required' => false,
'example' => '开发团队',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'GroupId' => [
'description' => '用户组ID。',
'type' => 'string',
'example' => 'g-FpMEHiMysofp****',
],
'UpdateDate' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'GroupName' => [
'description' => '用户组名称。',
'type' => 'string',
'example' => 'NewDev-Team',
],
'Comments' => [
'description' => '备注信息。',
'type' => 'string',
'example' => '开发团队',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'EC6647CC-0A36-EC7A-BA72-CC81BF3DE182',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Group\\": {\\n \\"GroupId\\": \\"g-FpMEHiMysofp****\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"GroupName\\": \\"NewDev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n \\"RequestId\\": \\"EC6647CC-0A36-EC7A-BA72-CC81BF3DE182\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"EC6647CC-0A36-EC7A-BA72-CC81BF3DE182\\",\\n \\"Group\\": {\\n \\"GroupName\\": \\"NewDev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\" : \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\" : \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"\\n\\n\\tEC6647CC-0A36-EC7A-BA72-CC81BF3DE182\\n\\t\\n\\t\\tNewDev-Team\\n\\t\\t开发团队\\n\\t\\t2015-01-23T12:33:18Z\\n\\t\\t2015-01-23T12:33:18Z\\n g-FpMEHiMysofp****\\n\\t\\n\\t\\n","errorExample":"\\n EC6647CC-0A36-EC7A-BA72-CC81BF3DE182\\n \\n NewDev-Team\\n 开发团队\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '修改用户组信息',
'summary' => '调用UpdateGroup接口修改用户组信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。'."\n"
."\n"
.'您可以通过[ListGroups](~~28703~~)查看用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FCF40AB5-881C-A0F9-334C-B0AD423AA69D',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FCF40AB5-881C-A0F9-334C-B0AD423AA69D\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"FCF40AB5-881C-A0F9-334C-B0AD423AA69D\\"\\n}"},{"type":"xml","example":"\\r\\n\\r\\n\\tFCF40AB5-881C-A0F9-334C-B0AD423AA69D\\r\\n","errorExample":"\\n FCF40AB5-881C-A0F9-334C-B0AD423AA69D\\n"}]',
'title' => '删除指定的用户组',
'summary' => '调用DeleteGroup接口删除指定的用户组。',
'description' => '删除用户组前,请确保用户组没有绑定任何权限策略且用户组内没有RAM用户。'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGroups' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => [
'description' => '查询返回结果下一页的令牌。首次调用API不需要`Marker`。'."\n"
."\n"
.'当您首次调用API时,如果返回数据总条数超过`MaxItems`限制,数据会被截断,只返回`MaxItems`条数据,同时,返回参数`IsTruncated`为`true`,返回一个`Marker`。您可以使用上一次返回的`Marker`继续调用API,其他请求参数保持不变,查询被截断的数据。您可以按此方法经过多次查询,直到`IsTruncated`为`false`时,表示全部数据查询完毕。',
'type' => 'string',
'required' => false,
'example' => 'EXAMPLE',
],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => [
'description' => '每页的最大数据条数。'."\n"
."\n"
.'取值范围:1~100。'."\n"
."\n"
.'默认值:100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '065527AA-2F2E-AD7C-7484-F2626CFE4934',
],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'array',
'items' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'GroupId' => [
'description' => '用户组ID。',
'type' => 'string',
'example' => 'g-FpMEHiMysofp****',
],
'UpdateDate' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'GroupName' => [
'description' => '用户组名称。',
'type' => 'string',
'example' => 'Dev-Team',
],
'Comments' => [
'description' => '备注信息。',
'type' => 'string',
'example' => '开发团队',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
],
],
],
'IsTruncated' => [
'description' => '请求返回结果是否被截断。取值:'."\n"
."\n"
.'- true'."\n"
.'- false',
'type' => 'boolean',
'example' => 'true',
],
'Marker' => [
'description' => '查询返回结果下一页的令牌。'."\n"
.'> 只有`IsTruncated`为`true`时,才显示该参数。',
'type' => 'string',
'example' => 'EXAMPLE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"065527AA-2F2E-AD7C-7484-F2626CFE4934\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"GroupId\\": \\"g-FpMEHiMysofp****\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n ]\\n },\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"065527AA-2F2E-AD7C-7484-F2626CFE4934\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"CreateDate\\" : \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\" : \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"GroupName\\": \\"QA-Team\\",\\n \\"Comments\\": \\"测试团队\\",\\n \\"CreateDate\\" : \\"2015-02-18T17:22:08Z\\",\\n \\"UpdateDate\\" : \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\r\\n\\r\\n\\t065527AA-2F2E-AD7C-7484-F2626CFE4934\\r\\n\\ttrue\\r\\n\\tEXAMPLE\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tDev-Team\\r\\n\\t\\t\\t开发团队\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t\\tg-FpMEHiMysofp****\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tQA-Team\\r\\n\\t\\t\\t测试团队\\r\\n\\t\\t\\t2015-02-18T17:22:08Z\\r\\n\\t\\t\\t2015-02-18T17:22:08Z\\r\\n\\t\\t\\tg-zYtroLrgbZR1****\\r\\n\\t\\t\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":"\\n 065527AA-2F2E-AD7C-7484-F2626CFE4934\\n true\\n EXAMPLE\\n \\n \\n Dev-Team\\n 开发团队\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n \\n QA-Team\\n 测试团队\\n 2015-02-18T17:22:08Z\\n 2015-02-18T17:22:08Z\\n \\n \\n"}]',
'title' => '查询用户组列表',
'summary' => '查询用户组列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListGroupsForUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Alice',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DA772B52-BF9F-54CA-AC77-AA7A2DA89D46',
],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'array',
'items' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'GroupId' => [
'description' => '用户组ID。',
'type' => 'string',
'example' => 'g-zYtroLrgbZR1****',
],
'GroupName' => [
'description' => '用户组名称。',
'type' => 'string',
'example' => 'Dev-Team',
],
'Comments' => [
'description' => '备注信息。',
'type' => 'string',
'example' => '开发团队',
],
'JoinDate' => [
'description' => '加入时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA772B52-BF9F-54CA-AC77-AA7A2DA89D46\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"GroupId\\": \\"g-zYtroLrgbZR1****\\",\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"JoinDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n DA772B52-BF9F-54CA-AC77-AA7A2DA89D46\\n \\n \\n Dev-Team\\n 开发团队\\n 2015-01-23T12:33:18Z\\n g-zYtroLrgbZR1****\\n \\n \\n","errorExample":""}]',
'title' => '列出指定RAM用户所加入的用户组信息',
'summary' => '调用ListGroupsForUser接口查询指定RAM用户所加入的用户组信息。',
'description' => '### 使用说明'."\n"
.'本文将提供一个示例,查询RAM用户`Alice`加入的用户组信息。返回结果显示,`Alice`加入了名为`Dev-Team`的用户组。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListUsersForGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
[
'name' => 'Marker',
'in' => 'query',
'schema' => [
'description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。',
'type' => 'string',
'required' => false,
'example' => 'EXAMPLE',
],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => [
'description' => '指定返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。'."\n"
."\n"
.'取值范围:1 ~ 1000,默认值:100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '4B450CA1-36E8-4AA2-8461-86B42BF4CC4E',
],
'IsTruncated' => [
'description' => '请求返回结果是否被截断。',
'type' => 'boolean',
'example' => 'true',
],
'Marker' => [
'description' => '当`IsTruncated`为`true`时才有此字段。当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容。',
'type' => 'string',
'example' => 'EXAMPLE',
],
'Users' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '用户信息。',
'type' => 'array',
'items' => [
'description' => '用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '显示名称。',
'type' => 'string',
'example' => 'Alice',
],
'JoinDate' => [
'description' => '加入日期。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'UserName' => [
'description' => '用户名称。',
'type' => 'string',
'example' => 'Alice',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"Alice\\",\\n \\"JoinDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UserName\\": \\"Alice\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\" : \\"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\",\\n \\"Users\\" : {\\n \\"User\\" : [\\n {\\n \\"UserId\\" : \\"1227489245380721\\",\\n \\"UserName\\" : \\"zhangqiang\\",\\n \\"DisplayName\\" : \\"张强\\",\\n \\"JoinDate\\" : \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"UserId\\" : \\"1406498224724456\\",\\n \\"UserName\\" : \\"lili\\",\\n \\"DisplayName\\" : \\"李丽\\",\\n \\"JoinDate\\" : \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"4B450CA1-36E8-4AA2-8461-86B42BF4CC4E\\n\\n \\n zhangqiang\\n 张强\\n 2015-01-23T12:33:18Z\\n \\n \\n lili\\n 李丽\\n 2015-02-18T17:22:08Z\\n \\n","errorExample":"\\n 5756784B-79C4-E82E-24C2-FC3E171E5AB3\\n \\n \\n 1227489245380721\\n zhangqiang\\n 张强\\n 2015-01-23T12:33:18Z\\n \\n \\n 1406498224724456\\n lili\\n 李丽\\n 2015-02-18T17:22:08Z\\n \\n \\n"}]',
'title' => '列出指定用户组所包含的RAM用户',
'summary' => '调用ListUsersForGroup接口列出指定用户组所包含的RAM用户。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AddUserToGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '用户名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '1B968853-B423-63A6-FE1F-45E81BC2AD61',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1B968853-B423-63A6-FE1F-45E81BC2AD61\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"1B968853-B423-63A6-FE1F-45E81BC2AD61\\"\\n}"},{"type":"xml","example":"1B968853-B423-63A6-FE1F-45E81BC2AD61","errorExample":"\\n 1B968853-B423-63A6-FE1F-45E81BC2AD61\\n"}]',
'title' => '将RAM用户添加到指定的用户组',
'summary' => '调用AddUserToGroup接口将RAM用户添加到指定的用户组。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'RemoveUserFromGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Dev-Team',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A07EF215-B9B3-8CB2-2899-3F9575C6E320',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A07EF215-B9B3-8CB2-2899-3F9575C6E320\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"A07EF215-B9B3-8CB2-2899-3F9575C6E320\\"\\n}"},{"type":"xml","example":"\\n A07EF215-B9B3-8CB2-2899-3F9575C6E320\\n","errorExample":"\\n A07EF215-B9B3-8CB2-2899-3F9575C6E320\\n"}]',
'title' => '将RAM用户从用户组中移除',
'summary' => '调用RemoveUserFromGroup接口将RAM用户从用户组中移除。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreateRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => 'RAM角色名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)和短划线(-)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ECSAdmin',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => 'RAM角色描述。'."\n"
."\n"
.'长度为1~1024个字符。',
'type' => 'string',
'required' => false,
'example' => 'ECS管理角色',
],
],
[
'name' => 'AssumeRolePolicyDocument',
'in' => 'query',
'schema' => [
'description' => '信任策略。指定允许扮演该RAM角色的一个或多个主体,这个主体可以是阿里云账号、阿里云服务或身份提供商。'."\n"
.'>RAM用户不能扮演可信实体为阿里云服务的RAM角色。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{"Statement":[{"Action":"sts:AssumeRole","Effect":"Allow","Principal":{"RAM":"acs:ram::123456789012****:root"}}],"Version":"1"}',
],
],
[
'name' => 'MaxSessionDuration',
'in' => 'query',
'schema' => [
'description' => 'RAM角色最大会话时间。'."\n"
."\n\n"
.'取值范围:3600秒~43200秒。默认值:3600秒。'."\n"
."\n"
.'取值为空时将采用默认值。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3600',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'k1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'v1',
],
],
'required' => false,
'docRequired' => false,
],
'required' => false,
'docRequired' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Role' => [
'description' => 'RAM角色信息。',
'type' => 'object',
'properties' => [
'AssumeRolePolicyDocument' => [
'description' => 'RAM角色的信任策略。',
'type' => 'string',
'example' => '{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }',
],
'Description' => [
'description' => 'RAM角色描述。',
'type' => 'string',
'example' => 'ECS管理角色',
],
'MaxSessionDuration' => [
'description' => 'RAM角色最大会话时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3600',
],
'RoleName' => [
'description' => 'RAM角色名称。',
'type' => 'string',
'example' => 'ECSAdmin',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'RoleId' => [
'description' => 'RAM角色ID。',
'type' => 'string',
'example' => '901234567890****',
],
'Arn' => [
'description' => 'RAM角色的资源描述符。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:role/ECSAdmin',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Role\\": {\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [ { \\\\\\"Action\\\\\\": \\\\\\"sts:AssumeRole\\\\\\", \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Principal\\\\\\": { \\\\\\"RAM\\\\\\": \\\\\\"acs:ram::123456789012****:root\\\\\\" } } ], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RoleId\\": \\"901234567890****\\",\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Role\\": {\\n \\"RoleId\\": \\"901234567890123\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/ECSAdmin\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [ { \\\\\\"Action\\\\\\": \\\\\\"sts:AssumeRole\\\\\\", \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Principal\\\\\\": { \\\\\\"RAM\\\\\\": \\\\\\"acs:ram::123456789012345678:root\\\\\\" } } ], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"\\n\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\n\\t\\n\\t\\t901234567890****\\n\\t\\tECSAdmin\\n\\t\\tacs:ram::123456789012****:role/ECSAdmin\\n\\t\\tECS管理角色\\n\\t\\t3600\\n\\t\\t{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }\\n\\t\\t2015-01-23T12:33:18Z\\n\\t\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 901234567890123\\n ECSAdmin\\n acs:ram::1234567890123456:role/ECSAdmin\\n ECS管理角色\\n { \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::123456789012345678:root\\" } } ], \\"Version\\": \\"1\\" }\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '创建角色',
'summary' => '调用CreateRole接口创建RAM角色。',
'description' => '### 使用说明'."\n"
.'关于RAM角色的介绍,请参见[RAM角色概览](~~93689~~)。',
'requestParamsDescription' => '**AssumeRolePolicyDocument示例**'."\n"
."\n"
.'- 以下策略表示:允许扮演该RAM角色的可信实体为阿里云账号(AccountID=`123456789012****`)下被授权的任何RAM用户。'."\n"
.'```'."\n"
.'{'."\n"
.' "Statement": [{'."\n"
.' "Action": "sts:AssumeRole",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "RAM": ['."\n"
.' "acs:ram::123456789012****:root"'."\n"
.' ]'."\n"
.' }'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}'."\n"
.'```'."\n"
.'- 以下策略表示:允许扮演该RAM角色的可信实体为阿里云账号(AccountID=`123456789012****`)下被授权的RAM用户`testuser`。'."\n"
.'>创建该角色前,请确保已创建RAM用户`testuser`(其登录名称为:`testuser@123456789012****.onaliyun.com`)。'."\n"
.'```'."\n"
.'{'."\n"
.' "Statement": [{'."\n"
.' "Action": "sts:AssumeRole",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "RAM": ['."\n"
.' "acs:ram::123456789012****:user/testuser"'."\n"
.' ]'."\n"
.' }'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}'."\n"
.'```'."\n"
.'- 以下策略表示:允许扮演该RAM角色的可信实体为当前阿里云账号下的ECS服务。'."\n"
.'```'."\n"
.'{'."\n"
.' "Statement": [{'."\n"
.' "Action": "sts:AssumeRole",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "Service": ['."\n"
.' "ecs.aliyuncs.com"'."\n"
.' ]'."\n"
.' }'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'- 以下策略表示:允许扮演该RAM角色的可信实体为当前阿里云账号(AccountID=`123456789012****`)下的SAML身份提供商`testprovider`。'."\n"
.'>创建此角色前,请确保已创建SAML身份提供商`testprovider`。'."\n"
.'```'."\n"
.'{'."\n"
.' "Statement": [{'."\n"
.' "Action": "sts:AssumeRole",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "Federated": ['."\n"
.' "acs:ram::123456789012****:saml-provider/testprovider"'."\n"
.' ]'."\n"
.' },'."\n"
.' "Condition": {'."\n"
.' "StringEquals": {'."\n"
.' "saml:recipient": "https://signin.aliyun.com/saml-role/sso"'."\n"
.' }'."\n"
.' }'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}'."\n"
.'```'."\n"
."\n\n"
.'- 以下策略表示:允许扮演该RAM角色的可信实体为当前阿里云账号(AccountID=`123456789012****`)下的OIDC身份提供商`TestOIDCProvider`。'."\n"
.'>创建此角色前,请确保已创建OIDC身份提供商`TestOIDCProvider`。'."\n"
.'```'."\n"
.'{'."\n"
.' "Statement": [{'."\n"
.' "Action": "sts:AssumeRole",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "Federated": ['."\n"
.' "acs:ram::123456789012****:oidc-provider/TestOIDCProvider"'."\n"
.' ]'."\n"
.' },'."\n"
.' "Condition": {'."\n"
.' "StringEquals": {'."\n"
.' "oidc:aud": ['."\n"
.' "496271242565057****"'."\n"
.' ],'."\n"
.' "oidc:iss": "https://dev-xxxxxx.okta.com",'."\n"
.' "oidc:sub": "KryrkIdjylZb7agUgCEf****"'."\n"
.' }'."\n"
.' }'."\n"
.' }],'."\n"
.' "Version": "1"'."\n"
.'}'."\n"
.'```',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => 'RAM角色名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ECSAdmin',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '898FAB24-7509-43EE-A287-086FE4C44394',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}"},{"type":"xml","example":"\\n 898FAB24-7509-43EE-A287-086FE4C44394\\n","errorExample":"\\n 898FAB24-7509-43EE-A287-086FE4C44394\\n"}]',
'title' => '删除角色',
'summary' => '调用DeleteRole接口删除普通RAM角色。',
'description' => '删除普通RAM角色前,请调用[DetachPolicyFromRole](~~2337680~~)移除RAM角色的所有权限策略。'."\n"
."\n"
.'本接口只能删除普通RAM角色,不能删除服务关联角色和云服务保留角色。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdateRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => 'RAM角色名称。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、半角句号(.)和短划线(-)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ECSAdmin',
],
],
[
'name' => 'NewAssumeRolePolicyDocument',
'in' => 'query',
'schema' => [
'description' => 'RAM角色的信任策略。',
'type' => 'string',
'required' => false,
'example' => '{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::12345678901234****:root" } } ], "Version": "1" }',
],
],
[
'name' => 'NewMaxSessionDuration',
'in' => 'query',
'schema' => [
'description' => 'RAM角色最大会话时间。'."\n"
."\n"
.'取值范围:3600秒~43200秒。默认值:3600秒。'."\n"
."\n"
.'取值为空时将采用默认值。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '3600',
],
],
[
'name' => 'NewDescription',
'in' => 'query',
'schema' => [
'description' => 'RAM角色描述。'."\n"
."\n"
.'长度为1~1024个字符。',
'type' => 'string',
'required' => false,
'example' => 'ECS管理角色',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Role' => [
'description' => 'RAM角色信息。',
'type' => 'object',
'properties' => [
'AssumeRolePolicyDocument' => [
'description' => 'RAM角色的信任策略。',
'type' => 'string',
'example' => '{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }',
],
'UpdateDate' => [
'description' => 'RAM角色的更新时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'Description' => [
'description' => 'RAM角色描述。',
'type' => 'string',
'example' => 'ECS管理角色',
],
'MaxSessionDuration' => [
'description' => 'RAM角色最大会话时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3600',
],
'RoleName' => [
'description' => 'RAM角色名称。',
'type' => 'string',
'example' => 'ECSAdmin',
],
'CreateDate' => [
'description' => 'RAM角色的创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'RoleId' => [
'description' => 'RAM角色ID。',
'type' => 'string',
'example' => '901234567890****',
],
'Arn' => [
'description' => 'RAM角色的资源描述符。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:role/ECSAdmin',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Role\\": {\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [ { \\\\\\"Action\\\\\\": \\\\\\"sts:AssumeRole\\\\\\", \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Principal\\\\\\": { \\\\\\"RAM\\\\\\": \\\\\\"acs:ram::123456789012****:root\\\\\\" } } ], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RoleId\\": \\"901234567890****\\",\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Role\\": {\\n \\"RoleId\\": \\"901234567890123\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/ECSAdmin\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [ { \\\\\\"Action\\\\\\": \\\\\\"sts:AssumeRole\\\\\\", \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Principal\\\\\\": { \\\\\\"RAM\\\\\\": \\\\\\"acs:ram::123456789012345678:root\\\\\\" } } ], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"\\n\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\n\\t\\n\\t\\t901234567890****\\n\\t\\tECSAdmin\\n\\t\\tacs:ram::123456789012****:role/ECSAdmin\\n\\t\\tECS管理角色\\n\\t\\t3600\\n\\t\\t{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }\\n\\t\\t2015-01-23T12:33:18Z\\n\\t\\t2015-01-23T12:33:18Z\\n\\t\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 901234567890123\\n ECSAdmin\\n acs:ram::1234567890123456:role/ECSAdmin\\n ECS管理角色\\n { \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::123456789012345678:root\\" } } ], \\"Version\\": \\"1\\" }\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '更新角色信息',
'summary' => '调用UpdateRole接口更新RAM角色信息。',
'description' => '本文将提供一个示例,更新RAM角色`ECSAdmin`的描述信息为`ECS管理员`。',
'requestParamsDescription' => ' 关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => '指定角色名。'."\n"
."\n"
.'长度为1~64个字符,可包含英文字母、数字、点号(.)和短划线(-)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'ECSAdmin',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Role' => [
'description' => '角色信息。',
'type' => 'object',
'properties' => [
'AssumeRolePolicyDocument' => [
'description' => '扮演角色的权限策略。',
'type' => 'string',
'example' => '{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }',
],
'UpdateDate' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'Description' => [
'description' => '角色描述。',
'type' => 'string',
'example' => 'ECS管理角色',
],
'MaxSessionDuration' => [
'description' => '角色最大会话时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3600',
],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'example' => 'ECSAdmin',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'RoleId' => [
'description' => '角色ID。',
'type' => 'string',
'example' => '901234567890****',
],
'Arn' => [
'description' => '角色的资源描述符。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:role/ECSAdmin',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Role\\": {\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [ { \\\\\\"Action\\\\\\": \\\\\\"sts:AssumeRole\\\\\\", \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Principal\\\\\\": { \\\\\\"RAM\\\\\\": \\\\\\"acs:ram::123456789012****:root\\\\\\" } } ], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RoleId\\": \\"901234567890****\\",\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\"\\n },\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"Role\\": {\\n \\"RoleId\\": \\"901234567890123\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/ECSAdmin\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"AssumeRolePolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [ { \\\\\\"Action\\\\\\": \\\\\\"sts:AssumeRole\\\\\\", \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Principal\\\\\\": { \\\\\\"RAM\\\\\\": \\\\\\"acs:ram::123456789012345678:root\\\\\\" } } ], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"\\r\\n\\r\\n\\t04F0F334-1335-436C-A1D7-6C044FE73368\\r\\n\\t\\r\\n\\t\\t901234567890****\\r\\n\\t\\tECSAdmin\\r\\n\\t\\tacs:ram::123456789012****:role/ECSAdmin\\r\\n\\t\\tECS管理角色\\r\\n\\t\\t3600\\r\\n\\t\\t{ "Statement": [ { "Action": "sts:AssumeRole", "Effect": "Allow", "Principal": { "RAM": "acs:ram::123456789012****:root" } } ], "Version": "1" }\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\t2015-01-23T12:33:18Z\\r\\n\\t\\r\\n\\r\\n\\t\\r\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 901234567890123\\n ECSAdmin\\n acs:ram::1234567890123456:role/ECSAdmin\\n ECS管理角色\\n { \\"Statement\\": [ { \\"Action\\": \\"sts:AssumeRole\\", \\"Effect\\": \\"Allow\\", \\"Principal\\": { \\"RAM\\": \\"acs:ram::123456789012345678:root\\" } } ], \\"Version\\": \\"1\\" }\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '获取角色信息',
'summary' => '调用GetRole接口获取角色信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListRoles' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'Marker',
'in' => 'query',
'schema' => [
'description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。',
'type' => 'string',
'required' => false,
'example' => 'EXAMPLE',
],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => [
'description' => '返回结果的条数。当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。'."\n"
."\n"
.'取值范围:1 ~ 1000。默认值:100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'owner',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'alice',
],
],
'required' => false,
'docRequired' => false,
],
'required' => false,
'docRequired' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
'IsTruncated' => [
'description' => '请求返回结果是否被截断。',
'type' => 'boolean',
'example' => 'true',
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '角色信息。',
'type' => 'array',
'items' => [
'description' => '角色信息。',
'type' => 'object',
'properties' => [
'Description' => [
'description' => '角色描述。',
'type' => 'string',
'example' => 'ECS管理角色',
],
'UpdateDate' => [
'description' => '更新时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'MaxSessionDuration' => [
'description' => '角色最大会话时间。',
'type' => 'integer',
'format' => 'int64',
'example' => '3600',
],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'example' => 'ECSAdmin',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'RoleId' => [
'description' => '角色ID。',
'type' => 'string',
'example' => '901234567890****',
],
'Arn' => [
'description' => '角色的资源描述符。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:role/ECSAdmin',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'owner',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'alice',
],
],
'required' => false,
],
],
],
],
],
],
],
],
],
'Marker' => [
'description' => '当`IsTruncated`为`true`时才有此字段。当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容。',
'type' => 'string',
'example' => 'EXAMPLE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"IsTruncated\\": true,\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"MaxSessionDuration\\": 3600,\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"RoleId\\": \\"901234567890****\\",\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"owner\\",\\n \\"TagValue\\": \\"alice\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"RoleId\\": \\"901234567890123\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/ECSAdmin\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"RoleId\\": \\"901234567890456\\",\\n \\"RoleName\\": \\"OSSReadonlyAccess\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/OSSReadonlyAccess\\",\\n \\"Description\\": \\"OSS只读访问角色\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n\\n\\t7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n\\ttrue\\n\\tEXAMPLE\\n\\t\\n\\t\\t\\n\\t\\t\\t901234567890****\\n\\t\\t\\tECSAdmin\\n\\t\\t\\tacs:ram::123456789012****:role/ECSAdmin\\n\\t\\t\\tECS管理角色\\n\\t\\t\\t3600\\n\\t\\t\\t2015-01-23T12:33:18Z\\n\\t\\t\\t2015-01-23T12:33:18Z\\n\\t\\t\\n\\t\\t\\n\\t\\t\\t901234567890****\\n\\t\\t\\tOSSReadonlyAccess\\n\\t\\t\\tacs:ram::123456789012****:role/OSSReadonlyAccess\\n\\t\\t\\tOSS只读访问角色\\n\\t\\t\\t3600\\n\\t\\t\\t2015-01-23T12:33:18Z\\n\\t\\t\\t2015-01-23T12:33:18Z\\n\\t\\t\\n\\t\\n\\t\\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n 901234567890123\\n ECSAdmin\\n acs:ram::1234567890123456:role/ECSAdmin\\n ECS管理角色\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n \\n 901234567890456\\n OSSReadonlyAccess\\n acs:ram::1234567890123456:role/OSSReadonlyAccess\\n OSS只读访问角色\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n \\n \\n"}]',
'title' => '获取角色列表',
'summary' => '列出角色。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreatePolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。'."\n"
."\n"
.'长度为1~128个字符,可包含英文字母、数字和短划线(-)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'View-ECS-instances-in-a-specific-region',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => [
'description' => '权限策略描述。'."\n"
."\n"
.'长度为1~1024个字符。',
'type' => 'string',
'required' => false,
'example' => '查看指定地域ECS实例',
],
],
[
'name' => 'PolicyDocument',
'in' => 'query',
'schema' => [
'description' => '权限策略内容。'."\n"
."\n"
.'长度为1~6144个字符。'."\n"
."\n"
.'关于权限策略元素和示例,请参见[权限策略基本元素](~~93738~~)和[权限策略示例库](~~210969~~)。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{"Statement": [{"Effect": "Allow","Action": "ecs:Describe*","Resource": "acs:ecs:cn-qingdao:*:instance/*"}],"Version": "1"}',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'owner',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'alice',
],
],
'required' => false,
'docRequired' => false,
],
'required' => false,
'docRequired' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '权限策略信息。',
'type' => 'object',
'properties' => [
'DefaultVersion' => [
'description' => '权限策略版本。默认值:v1。',
'type' => 'string',
'example' => 'v1',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => '查看指定地域ECS实例',
],
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'View-ECS-instances-in-a-specific-region',
],
'CreateDate' => [
'description' => '权限策略创建时间。',
'type' => 'string',
'example' => '2021-10-13T02:46:57Z',
],
'PolicyType' => [
'description' => '权限策略类型。取值:'."\n"
."\n"
.'- Custom:自定义策略。'."\n"
.'- System:系统策略。',
'type' => 'string',
'example' => 'Custom',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'BA34C54A-C2B1-5A65-B6B0-B5842C1DB4DA',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policy\\": {\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"查看指定地域ECS实例\\",\\n \\"PolicyName\\": \\"View-ECS-instances-in-a-specific-region\\",\\n \\"CreateDate\\": \\"2021-10-13T02:46:57Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n },\\n \\"RequestId\\": \\"BA34C54A-C2B1-5A65-B6B0-B5842C1DB4DA\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\n\\t\\n\\t\\tCustom\\n\\t\\t查看指定地域ECS实例\\n\\t\\tv1\\n\\t\\tView-ECS-instances-in-a-specific-region\\n\\t\\t2021-10-13T02:46:57Z\\n\\t\\n\\tBA34C54A-C2B1-5A65-B6B0-B5842C1DB4DA\\n","errorExample":""}]',
'title' => '创建一个权限策略',
'summary' => '调用CreatePolicy接口创建一个自定义权限策略。',
'description' => '关于权限策略的介绍,请参见[权限策略概览](~~93732~~)。'."\n"
."\n"
.'本文将提供一个示例,创建一个权限策略,用来查看指定地域的ECS实例。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Policy' => [
'description' => '权限策略的基本信息。',
'type' => 'object',
'properties' => [
'DefaultVersion' => [
'description' => '默认版本。',
'type' => 'string',
'example' => 'v1',
],
'UpdateDate' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => 'OSS管理员权限',
],
'PolicyDocument' => [
'description' => '已废弃。',
'type' => 'string',
'example' => 'N/A',
],
'AttachmentCount' => [
'description' => '引用次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'OSS-Administrator',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'PolicyType' => [
'description' => '权限策略类型。',
'type' => 'string',
'example' => 'Custom',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
'DefaultPolicyVersion' => [
'description' => '权限策略的默认版本。',
'type' => 'object',
'properties' => [
'IsDefaultVersion' => [
'description' => '`DefaultPolicyVersion`返回的数据结构固定为默认版本,因此`IsDefaultVersion`的取值固定为`true`。',
'type' => 'boolean',
'example' => 'true',
],
'PolicyDocument' => [
'description' => '权限策略内容。',
'type' => 'string',
'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}',
],
'VersionId' => [
'description' => '权限策略版本。',
'type' => 'string',
'example' => 'v1',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policy\\": {\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyDocument\\": \\"N/A\\",\\n \\"AttachmentCount\\": 0,\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n },\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\",\\n \\"DefaultPolicyVersion\\": {\\n \\"IsDefaultVersion\\": true,\\n \\"PolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oss:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": [\\\\\\"acs:oss:*:*:*\\\\\\"]}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"VersionId\\": \\"v1\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\",\\n \\"Policy\\": {\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AttachmentCount\\": 0\\n }\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n 0\\n \\n \\n\\t\\tv1\\n\\t\\ttrue\\n\\t\\t2015-01-23T12:33:18Z\\n\\t\\t{ \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}\\n \\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n 0\\n \\n"}]',
'title' => '获取指定的权限策略信息',
'summary' => '调用GetPolicy接口获取指定的权限策略信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'UpdatePolicyDescription' => [
'summary' => '调用UpdatePolicyDescription更新自定义策略的描述信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'example' => 'TestPolicy',
],
],
[
'name' => 'NewDescription',
'in' => 'query',
'schema' => [
'description' => '权限策略描述。'."\n"
."\n"
.'长度为1~1024个字符。',
'type' => 'string',
'required' => false,
'example' => 'This is a test policy.',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '7572DEBD-0ECE-518E-8682-D8CB82F8FE8E',
],
'Policy' => [
'description' => '权限策略信息。',
'type' => 'object',
'properties' => [
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'TestPolicy',
],
'PolicyType' => [
'description' => '权限策略类型。取值:'."\n"
."\n"
.'- Custom:自定义策略。'."\n"
.'- System:系统策略。',
'type' => 'string',
'example' => 'Custom',
],
'CreateDate' => [
'description' => '权限策略创建时间。',
'type' => 'string',
'example' => '2022-02-28T07:04:15Z',
],
'UpdateDate' => [
'description' => '权限策略更新时间。',
'type' => 'string',
'example' => '2022-02-28T07:05:37Z',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => 'This is a test policy.',
],
'DefaultVersion' => [
'description' => '权限策略版本。默认值:v1。',
'type' => 'string',
'example' => 'v1',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7572DEBD-0ECE-518E-8682-D8CB82F8FE8E\\",\\n \\"Policy\\": {\\n \\"PolicyName\\": \\"TestPolicy\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"CreateDate\\": \\"2022-02-28T07:04:15Z\\",\\n \\"UpdateDate\\": \\"2022-02-28T07:05:37Z\\",\\n \\"Description\\": \\"This is a test policy.\\",\\n \\"DefaultVersion\\": \\"v1\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n Custom\\n 2022-02-28T07:05:37Z\\n This is a test policy.\\n TestPolicy\\n v1\\n 2022-02-28T07:04:15Z\\n \\n 7572DEBD-0ECE-518E-8682-D8CB82F8FE8E\\n","errorExample":""}]',
'title' => '更新自定义策略的描述信息',
'description' => '### 使用说明'."\n"
.'本API仅限更新自定义策略的描述信息,系统策略的描述信息不支持更新。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~28676~~)。',
],
'DeletePolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'CascadingDelete',
'in' => 'query',
'schema' => [
'description' => '是否级联删除权限策略的所有版本。取值:'."\n"
."\n"
.'- true:会级联删除所有版本。'."\n"
.'- false:不会级联删除,需要您在删除权限策略前,手动删除权限策略非默认版本。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '898FAB24-7509-43EE-A287-086FE4C44394',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"898FAB24-7509-43EE-A287-086FE4C44394\\"\\n}"},{"type":"xml","example":"\\n 898FAB24-7509-43EE-A287-086FE4C44394\\n","errorExample":"\\n 898FAB24-7509-43EE-A287-086FE4C44394\\n"}]',
'title' => '删除指定的权限策略',
'summary' => '调用DeletePolicy接口删除指定的权限策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPolicies' => [
'summary' => '调用ListPolicies接口列出权限策略。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定`Policy`的类型,取值为`System`或`Custom`,如果没有指定则列出所有权限策略。',
'type' => 'string',
'required' => false,
'example' => 'System',
],
],
[
'name' => 'Marker',
'in' => 'query',
'schema' => [
'description' => '当请求的返回结果被截断时,可以使用`Marker`获取从当前截断位置之后的内容。',
'type' => 'string',
'required' => false,
'example' => 'EXAMPLE',
],
],
[
'name' => 'MaxItems',
'in' => 'query',
'schema' => [
'description' => '指定返回结果的条数,当返回结果达到`MaxItems`限制被截断时,返回参数`IsTruncated`将等于`true`。'."\n"
."\n"
.'取值范围:1 ~ 1000,默认值:100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'owner',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'alice',
],
],
'required' => false,
'docRequired' => false,
],
'required' => false,
'docRequired' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Policies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Policy' => [
'description' => '权限策略信息。',
'type' => 'array',
'items' => [
'description' => '权限策略信息。',
'type' => 'object',
'properties' => [
'DefaultVersion' => [
'description' => '默认版本。',
'type' => 'string',
'example' => 'v1',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => 'OSS管理员权限',
],
'UpdateDate' => [
'description' => '修改时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'AttachmentCount' => [
'description' => '引用次数。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'OSS-Administrator',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'PolicyType' => [
'description' => '权限策略类型。',
'type' => 'string',
'example' => 'System',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'required' => false,
'example' => 'owner',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'required' => false,
'example' => 'alice',
],
],
],
],
],
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
'IsTruncated' => [
'description' => '请求返回结果是否被截断。',
'type' => 'boolean',
'example' => 'true',
],
'Marker' => [
'description' => '当`IsTruncated`为`true`时才有此字段,当返回`true`时,需要继续调用此接口,并且使用`Marker`获取截断后的内容。',
'type' => 'string',
'example' => 'EXAMPLE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AttachmentCount\\": 3,\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"owner\\",\\n \\"TagValue\\": \\"alice\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"IsTruncated\\": true,\\n \\"Marker\\": \\"EXAMPLE\\",\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"UpdateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"AttachmentCount\\": 3\\n },\\n {\\n \\"PolicyName\\": \\"ReadOnlyAccess\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"Description\\": \\"只读权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"CreateDate\\": \\"2015-02-11T18:39:12Z\\",\\n \\"UpdateDate\\": \\"2015-02-19T09:43:16Z\\",\\n \\"AttachmentCount\\": 1\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n true\\n EXAMPLE\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n 0\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-11T18:39:12Z\\n 2015-02-19T09:43:16Z\\n 0\\n \\n \\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n true\\n EXAMPLE\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n 2015-01-23T12:33:18Z\\n 0\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-11T18:39:12Z\\n 2015-02-19T09:43:16Z\\n 0\\n \\n \\n"}]',
'title' => '列出权限策略',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'CreatePolicyVersion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'PolicyDocument',
'in' => 'query',
'schema' => [
'description' => '权限策略内容,最大长度6144字节。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => '{"Statement":[{"Action":["oss:*"],"Effect":"Allow","Resource":["acs:oss:*:*:*"]}],"Version":"1"}',
],
],
[
'name' => 'SetAsDefault',
'in' => 'query',
'schema' => [
'description' => '是否设置为默认权限策略,默认值为`false`。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'RotateStrategy',
'in' => 'query',
'schema' => [
'description' => '权限策略版本自动化轮转机制,可以删除历史权限策略版本。'."\n"
."\n"
.'目前包含:'."\n"
."\n"
.'- `None`:关闭轮转机制。'."\n"
.'- `DeleteOldestNonDefaultVersionWhenLimitExceeded`:当权限策略版本数量超限时,删除最早且非活跃的版本。'."\n"
."\n"
.'默认值:`None`。'."\n",
'type' => 'string',
'required' => false,
'example' => 'None',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PolicyVersion' => [
'description' => '新建的权限策略版本的信息。',
'type' => 'object',
'properties' => [
'IsDefaultVersion' => [
'description' => '是否默认版本。',
'type' => 'boolean',
'example' => 'false',
],
'PolicyDocument' => [
'description' => '权限策略内容。',
'type' => 'string',
'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}',
],
'VersionId' => [
'description' => '权限策略标识。'."\n",
'type' => 'string',
'example' => 'v3',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyVersion\\": {\\n \\"IsDefaultVersion\\": false,\\n \\"PolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oss:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": [\\\\\\"acs:oss:*:*:*\\\\\\"]}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"VersionId\\": \\"v3\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"PolicyVersion\\": {\\n \\"VersionId\\": \\"v3\\",\\n \\"IsDefaultVersion\\": false,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n}"},{"type":"xml","example":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n v3\\n false\\n 2015-01-23T12:33:18Z\\n { \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}\\n \\n","errorExample":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n v3\\n false\\n 2015-01-23T12:33:18Z\\n \\n"}]',
'title' => '为权限策略创建新的版本',
'summary' => '调用CreatePolicyVersion接口为权限策略创建新的版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetPolicyVersion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'VersionId',
'in' => 'query',
'schema' => [
'description' => '指定目标版本的ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'v3',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PolicyVersion' => [
'description' => '权限策略版本信息。',
'type' => 'object',
'properties' => [
'IsDefaultVersion' => [
'description' => '是否默认版本。',
'type' => 'boolean',
'example' => 'false',
],
'PolicyDocument' => [
'description' => '权限策略内容。',
'type' => 'string',
'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}',
],
'VersionId' => [
'description' => '权限策略标识。',
'type' => 'string',
'example' => 'v3',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"PolicyVersion\\": {\\n \\"IsDefaultVersion\\": false,\\n \\"PolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oss:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": [\\\\\\"acs:oss:*:*:*\\\\\\"]}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"VersionId\\": \\"v3\\",\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\",\\n \\"PolicyVersion\\": {\\n \\"VersionId\\": \\"v3\\",\\n \\"IsDefaultVersion\\": false,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"PolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oss:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": [\\\\\\"acs:oss:*:*:*\\\\\\"]}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\"\\n }\\n}"},{"type":"xml","example":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n v3\\n false\\n 2015-01-23T12:33:18Z\\n \\n { \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}\\n \\n \\n","errorExample":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n \\n v3\\n false\\n 2015-01-23T12:33:18Z\\n \\n { \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}\\n \\n \\n"}]',
'title' => '获取某个权限策略的版本',
'summary' => '调用GetPolicyVersion接口获取某个权限策略的版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeletePolicyVersion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'VersionId',
'in' => 'query',
'schema' => [
'description' => '指定目标版本的ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'v3',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}"},{"type":"xml","example":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n","errorExample":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n"}]',
'title' => '删除指定的权限策略的某个版本',
'summary' => '调用DeletePolicyVersion接口删除指定的权限策略的某个版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPolicyVersions' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
'PolicyVersions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PolicyVersion' => [
'description' => '权限策略版本信息。',
'type' => 'array',
'items' => [
'description' => '权限策略版本信息。',
'type' => 'object',
'properties' => [
'IsDefaultVersion' => [
'description' => '是否默认版本。',
'type' => 'boolean',
'example' => 'false',
],
'PolicyDocument' => [
'description' => '权限策略内容。',
'type' => 'string',
'example' => '{ "Statement": [{ "Action": ["oss:*"], "Effect": "Allow", "Resource": ["acs:oss:*:*:*"]}], "Version": "1"}',
],
'VersionId' => [
'description' => '权限策略标识。',
'type' => 'string',
'example' => 'v3',
],
'CreateDate' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2015-02-26T01:25:52Z',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"PolicyVersions\\": {\\n \\"PolicyVersion\\": [\\n {\\n \\"IsDefaultVersion\\": false,\\n \\"PolicyDocument\\": \\"{ \\\\\\"Statement\\\\\\": [{ \\\\\\"Action\\\\\\": [\\\\\\"oss:*\\\\\\"], \\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\", \\\\\\"Resource\\\\\\": [\\\\\\"acs:oss:*:*:*\\\\\\"]}], \\\\\\"Version\\\\\\": \\\\\\"1\\\\\\"}\\",\\n \\"VersionId\\": \\"v3\\",\\n \\"CreateDate\\": \\"2015-02-26T01:25:52Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"PolicyVersions\\": {\\n \\"PolicyVersion\\": [\\n {\\n \\"VersionId\\": \\"v3\\",\\n \\"IsDefaultVersion\\": false,\\n \\"CreateDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"VersionId\\": \\"v5\\",\\n \\"IsDefaultVersion\\": true,\\n \\"CreateDate\\": \\"2015-02-26T01:25:52Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n v3\\n false\\n 2015-01-23T12:33:18Z\\n { \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}\\n \\n \\n v5\\n true\\n 2015-02-26T01:25:52Z\\n { \\"Statement\\": [{ \\"Action\\": [\\"oss:*\\"], \\"Effect\\": \\"Allow\\", \\"Resource\\": [\\"acs:oss:*:*:*\\"]}], \\"Version\\": \\"1\\"}\\n \\n \\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n v3\\n false\\n 2015-01-23T12:33:18Z\\n \\n \\n v5\\n true\\n 2015-02-26T01:25:52Z\\n \\n \\n"}]',
'title' => '列出权限策略版本',
'summary' => '调用ListPolicyVersions接口列出权限策略版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetDefaultPolicyVersion' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'VersionId',
'in' => 'query',
'schema' => [
'description' => '新默认版本的ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'v2',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}"},{"type":"xml","example":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n","errorExample":"\\n 9B34724D-54B0-4A51-B34D-4512372FE1BE\\n"}]',
'title' => '设置权限策略默认版本',
'summary' => '调用SetDefaultPolicyVersion接口设置权限策略默认版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AttachPolicyToUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n"}]',
'title' => '为指定用户添加权限',
'summary' => '调用AttachPolicyToUser接口为指定用户添加权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DetachPolicyFromUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => '指定用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n"}]',
'title' => '为用户撤销指定的权限',
'summary' => '调用DetachPolicyFromUser接口为用户撤销指定的权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AttachPolicyToGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '指定用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'dev',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n"}]',
'title' => '为指定用户组添加权限',
'summary' => '调用AttachPolicyToGroup接口为指定用户组添加权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DetachPolicyFromGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '指定用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'dev',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n"}]',
'title' => '为用户组撤销指定的权限',
'summary' => '调用DetachPolicyFromGroup接口为用户组撤销指定的权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'AttachPolicyToRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '指定权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => '指定角色名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSSAdminRole',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n"}]',
'title' => '为指定角色添加权限',
'summary' => '调用AttachPolicyToRole接口为指定角色添加权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DetachPolicyFromRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => '指定角色名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSSAdminRole',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}"},{"type":"xml","example":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n","errorExample":"\\n 697852FB-50D7-44D9-9774-530C31EAC572\\n"}]',
'title' => '为角色撤销指定的权限',
'summary' => '调用DetachPolicyFromRole接口为角色撤销指定的权限。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPoliciesForUser' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'UserName',
'in' => 'query',
'schema' => [
'description' => 'RAM用户名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'zhangq****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'Policies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Policy' => [
'description' => '权限策略信息。',
'type' => 'array',
'items' => [
'description' => '权限策略信息。',
'type' => 'object',
'properties' => [
'DefaultVersion' => [
'description' => '当前版本。',
'type' => 'string',
'example' => 'v1',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => 'OSS管理员权限',
],
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'OSS-Administrator',
],
'AttachDate' => [
'description' => '授权时间(UTC时间)。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'PolicyType' => [
'description' => '权限策略类型。取值:'."\n"
.'- System:系统策略。'."\n"
.'- Custom:自定义策略。',
'type' => 'string',
'example' => 'Custom',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"PolicyName\\": \\"ReadOnlyAccess\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"Description\\": \\"只读权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"AttachDate\\": \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n\\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-18T17:22:08Z\\n \\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-18T17:22:08Z\\n \\n \\n"}]',
'title' => '查询RAM用户的授权列表',
'summary' => '调用ListPoliciesForUser接口查询RAM用户的授权列表。',
'description' => '> 本接口只能查询授权范围为云账号的授权列表,不能查询授权范围为资源组的授权列表。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPoliciesForGroup' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => [
'description' => '指定用户组名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'dev',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Policies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Policy' => [
'description' => '权限策略信息。',
'type' => 'array',
'items' => [
'description' => '权限策略信息。',
'type' => 'object',
'properties' => [
'DefaultVersion' => [
'description' => '默认版本。',
'type' => 'string',
'example' => 'v1',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => 'OSS管理员权限',
],
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'OSS-Administrator',
],
'AttachDate' => [
'description' => '授权时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'PolicyType' => [
'description' => '权限策略类型。',
'type' => 'string',
'example' => 'Custom',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"PolicyName\\": \\"ReadOnlyAccess\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"Description\\": \\"只读权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"AttachDate\\": \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-18T17:22:08Z\\n \\n \\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-18T17:22:08Z\\n \\n \\n"}]',
'title' => '列出用户组的权限策略',
'summary' => '调用ListPoliciesForGroup接口列出用户组的权限策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListPoliciesForRole' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'RoleName',
'in' => 'query',
'schema' => [
'description' => '指定角色名。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'AdminRole',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Policies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Policy' => [
'description' => '权限策略信息。',
'type' => 'array',
'items' => [
'description' => '权限策略信息。',
'type' => 'object',
'properties' => [
'DefaultVersion' => [
'description' => '默认版本。',
'type' => 'string',
'example' => 'v1',
],
'Description' => [
'description' => '权限策略描述。',
'type' => 'string',
'example' => 'OSS管理员权限',
],
'PolicyName' => [
'description' => '权限策略名称。',
'type' => 'string',
'example' => 'OSS-Administrator',
],
'AttachDate' => [
'description' => '授权时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'PolicyType' => [
'description' => '权限策略类型。',
'type' => 'string',
'example' => 'Custom',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"PolicyType\\": \\"Custom\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"PolicyName\\": \\"OSS-Administrator\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"Description\\": \\"OSS管理员权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"PolicyName\\": \\"ReadOnlyAccess\\",\\n \\"PolicyType\\": \\"System\\",\\n \\"Description\\": \\"只读权限\\",\\n \\"DefaultVersion\\": \\"v1\\",\\n \\"AttachDate\\": \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-18T17:22:08Z\\n \\n \\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n OSS-Administrator\\n Custom\\n OSS管理员权限\\n v1\\n 2015-01-23T12:33:18Z\\n \\n \\n ReadOnlyAccess\\n System\\n 只读权限\\n v1\\n 2015-02-18T17:22:08Z\\n \\n \\n"}]',
'title' => '列出角色的权限策略',
'summary' => '调用ListPoliciesForRole接口列出角色的权限策略。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListEntitiesForPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'PolicyType',
'in' => 'query',
'schema' => [
'description' => '指定权限策略的类型,取值为`System`或`Custom`。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'Custom',
],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => [
'description' => '权限策略名称。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'OSS-Administrator',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7B8A4E7D-6CFF-471D-84DF-195A7A241ECB',
],
'Groups' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Group' => [
'description' => '用户组信息。',
'type' => 'array',
'items' => [
'description' => '用户组信息。',
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '组名称。',
'type' => 'string',
'example' => 'QA-Team',
],
'Comments' => [
'description' => '备注信息。',
'type' => 'string',
'example' => '测试团队',
],
'AttachDate' => [
'description' => '授权时间。',
'type' => 'string',
'example' => '2015-02-18T17:22:08Z',
],
],
],
],
],
],
'Roles' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Role' => [
'description' => '角色信息。',
'type' => 'array',
'items' => [
'description' => '角色信息。',
'type' => 'object',
'properties' => [
'Description' => [
'description' => '角色的文字描述。',
'type' => 'string',
'example' => 'ECS管理角色',
],
'RoleName' => [
'description' => '角色名称。',
'type' => 'string',
'example' => 'ECSAdmin',
],
'AttachDate' => [
'description' => '授权时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
'Arn' => [
'description' => '角色的资源描述符。',
'type' => 'string',
'example' => 'acs:ram::123456789012****:role/ECSAdmin',
],
'RoleId' => [
'description' => '角色ID。',
'type' => 'string',
'example' => '122748924538****',
],
],
],
],
],
],
'Users' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'User' => [
'description' => '用户信息。',
'type' => 'array',
'items' => [
'description' => '用户信息。',
'type' => 'object',
'properties' => [
'DisplayName' => [
'description' => '显示名称。',
'type' => 'string',
'example' => '张*',
],
'UserId' => [
'description' => '用户唯一标识。',
'type' => 'string',
'example' => '122748924538****',
],
'UserName' => [
'description' => '用户名称。',
'type' => 'string',
'example' => 'zhangq****',
],
'AttachDate' => [
'description' => '授权时间。',
'type' => 'string',
'example' => '2015-01-23T12:33:18Z',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Groups\\": {\\n \\"Group\\": [\\n {\\n \\"GroupName\\": \\"QA-Team\\",\\n \\"Comments\\": \\"测试团队\\",\\n \\"AttachDate\\": \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n },\\n \\"Roles\\": {\\n \\"Role\\": [\\n {\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"RoleName\\": \\"ECSAdmin\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\",\\n \\"Arn\\": \\"acs:ram::123456789012****:role/ECSAdmin\\",\\n \\"RoleId\\": \\"122748924538****\\"\\n }\\n ]\\n },\\n \\"Users\\": {\\n \\"User\\": [\\n {\\n \\"DisplayName\\": \\"张*\\",\\n \\"UserId\\": \\"122748924538****\\",\\n \\"UserName\\": \\"zhangq****\\",\\n \\"AttachDate\\": \\"2015-01-23T12:33:18Z\\"\\n }\\n ]\\n }\\n}","errorExample":"{\\n \\"RequestId\\" : \\"7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\",\\n \\"Groups\\" : {\\n \\"Group\\" : [\\n {\\n \\"GroupName\\": \\"QA-Team\\",\\n \\"Comments\\": \\"测试团队\\",\\n \\"AttachDate\\" : \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"GroupName\\": \\"Dev-Team\\",\\n \\"Comments\\": \\"开发团队\\",\\n \\"AttachDate\\" : \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n },\\n \\"Users\\" : {\\n \\"User\\" : [\\n {\\n \\"UserId\\" : \\"1227489245380721\\",\\n \\"UserName\\" : \\"zhangqiang\\",\\n \\"DisplayName\\": \\"张强\\",\\n \\"AttachDate\\" : \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"UserId\\" : \\"1406498224724456\\",\\n \\"UserName\\" : \\"lili\\",\\n \\"DisplayName\\": \\"李丽\\",\\n \\"AttachDate\\" : \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n },\\n \\"Roles\\" : {\\n \\"Role\\" : [\\n {\\n \\"RoleId\\" : \\"1227489245380721\\",\\n \\"RoleName\\" : \\"ECSAdmin\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/ECSAdmin\\",\\n \\"Description\\": \\"ECS管理角色\\",\\n \\"AttachDate\\" : \\"2015-01-23T12:33:18Z\\"\\n },\\n {\\n \\"RoleId\\" : \\"1406498224724456\\",\\n \\"RoleName\\" : \\"OSSReadonlyAccess\\",\\n \\"Arn\\": \\"acs:ram::1234567890123456:role/OSSReadonlyAccess\\",\\n \\"Description\\": \\"OSS只读访问角色\\",\\n \\"AttachDate\\" : \\"2015-02-18T17:22:08Z\\"\\n }\\n ]\\n }\\n}"},{"type":"xml","example":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n QA-Team\\n 测试团队\\n 2015-01-23T12:33:18Z\\n \\n \\n Dev-Team\\n 开发团队\\n 2015-02-18T17:22:08Z\\n \\n \\n \\n \\n 122748924538****\\n zhangq****\\n 张*\\n 2015-01-23T12:33:18Z\\n \\n \\n 140649822472****\\n li****\\n 李*\\n 2015-02-18T17:22:08Z\\n \\n \\n \\n \\n 122748924538****\\n ECSAdmin\\n acs:ram::123456789012****:role/ECSAdmin\\n ECS管理角色\\n 2015-01-23T12:33:18Z\\n \\n \\n 140649822472****\\n OSSReadonlyAccess\\n OSS只读访问角色\\n acs:ram::123456789012****:role/OSSReadonlyAccess\\n 2015-01-23T12:33:18Z\\n \\n \\n","errorExample":"\\n 7B8A4E7D-6CFF-471D-84DF-195A7A241ECB\\n \\n \\n QA-Team\\n 测试团队\\n 2015-01-23T12:33:18Z\\n \\n \\n Dev-Team\\n 开发团队\\n 2015-02-18T17:22:08Z\\n \\n \\n \\n \\n 1227489245380721\\n zhangqiang\\n 张强\\n 2015-01-23T12:33:18Z\\n \\n \\n 1406498224724456\\n lili\\n 李丽\\n 2015-02-18T17:22:08Z\\n \\n \\n \\n \\n 901234567890123\\n ECSAdmin\\n acs:ram::1234567890123456:role/ECSAdmin\\n ECS管理角色\\n 2015-01-23T12:33:18Z\\n \\n \\n 901234567890456\\n OSSReadonlyAccess\\n OSS只读访问角色\\n acs:ram::1234567890123456:role/OSSReadonlyAccess\\n 2015-01-23T12:33:18Z\\n \\n \\n"}]',
'title' => '列出引用权限策略的实体',
'summary' => '调用ListEntitiesForPolicy接口列出引用权限策略的实体。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetAccountAlias' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'AccountAlias',
'in' => 'query',
'schema' => [
'description' => '指定云账号的别名。'."\n"
."\n"
.'长度为3~32个字符,可以包含小写字母、数字和短划线(-)。'."\n"
.'>云账号别名不能以短横线开头或结尾且不能有两个连续的短横线。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'myalias',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。'."\n",
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '设置云账号别名',
'summary' => '调用SetAccountAlias接口设置云账号别名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetAccountAlias' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'AccountAlias' => [
'description' => '账号别名。',
'type' => 'string',
'example' => 'myalias',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AccountAlias\\": \\"myalias\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"AccountAlias\\": \\"myalias\\"\\n}"},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n myalias\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n myalias\\n"}]',
'title' => '查看云账号别名',
'summary' => '调用GetAccountAlias接口查看云账号别名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ClearAccountAlias' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\"\\n}"},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n"}]',
'title' => '清除云账号别名',
'summary' => '调用ClearAccountAlias接口清除云账号别名。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetPasswordPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'MinimumPasswordLength',
'in' => 'query',
'schema' => [
'description' => '最小密码长度。'."\n"
."\n"
.'取值范围:8~32。默认值:8。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '12',
],
],
[
'name' => 'RequireLowercaseCharacters',
'in' => 'query',
'schema' => [
'description' => '必须含有小写字母。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RequireUppercaseCharacters',
'in' => 'query',
'schema' => [
'description' => '必须含有大写字母。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RequireNumbers',
'in' => 'query',
'schema' => [
'description' => '必须含有数字。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'RequireSymbols',
'in' => 'query',
'schema' => [
'description' => '必须含有特殊字符。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'HardExpiry',
'in' => 'query',
'schema' => [
'description' => '密码是否过期。'."\n"
.'取值为`true`或`false`,如果未指定此参数的值,系统默认为`false`。'."\n"
."\n"
.'- 如果取值为`true`,此时必须由主账号重置密码后,RAM用户才能正常登录。'."\n"
.'- 如果取值为`false`,此时RAM用户可以在密码过期后自行更改密码,并继续以用户身份登录。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'MaxPasswordAge',
'in' => 'query',
'schema' => [
'description' => '密码有效期,单位是天(重置密码将重置密码过期时间)。0表示不启用密码过期策略,默认不启用。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'PasswordReusePrevention',
'in' => 'query',
'schema' => [
'description' => '禁止使用前N次密码。0表示不启用历史密码检查策略,默认不启用。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'MaxLoginAttemps',
'in' => 'query',
'schema' => [
'description' => '一小时内使用错误密码尝试登录最大次数(重置密码可清除尝试登录计数)。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'PasswordPolicy' => [
'description' => '密码策略。',
'type' => 'object',
'properties' => [
'RequireNumbers' => [
'description' => '必须包含数字。',
'type' => 'boolean',
'example' => 'true',
],
'RequireLowercaseCharacters' => [
'description' => '必须包含小写字母。',
'type' => 'boolean',
'example' => 'true',
],
'HardExpiry' => [
'description' => '密码是否过期。'."\n"
.'取值为`true`或`false`,如果未指定此参数的值,系统默认为`false`。'."\n"
."\n"
.'- 如果取值为`true`,此时必须由主账号重置密码后,RAM用户才能正常登录。'."\n"
.'- 如果取值为`false`,此时RAM用户可以在密码过期后自行更改密码,并继续以用户身份登录。',
'type' => 'boolean',
'example' => 'false',
],
'PasswordReusePrevention' => [
'description' => '禁止使用前N次密码。0表示不启用历史密码检查策略,默认不启用。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequireSymbols' => [
'description' => '必须包含字符。',
'type' => 'boolean',
'example' => 'true',
],
'MaxPasswordAge' => [
'description' => '密码有效期,单位是天(重置密码将重置密码过期时间)。0表示不启用密码过期策略,默认不启用。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'MinimumPasswordLength' => [
'description' => '最小密码长度。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'RequireUppercaseCharacters' => [
'description' => '必须包含大写字母。',
'type' => 'boolean',
'example' => 'true',
],
'MaxLoginAttemps' => [
'description' => '一小时内使用错误密码尝试登录最大次数(重置密码可清除尝试登录计数)。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PasswordPolicy\\": {\\n \\"RequireNumbers\\": true,\\n \\"RequireLowercaseCharacters\\": true,\\n \\"HardExpiry\\": false,\\n \\"PasswordReusePrevention\\": 0,\\n \\"RequireSymbols\\": true,\\n \\"MaxPasswordAge\\": 0,\\n \\"MinimumPasswordLength\\": 12,\\n \\"RequireUppercaseCharacters\\": true,\\n \\"MaxLoginAttemps\\": 5\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PasswordPolicy\\": {\\n \\"MinimumPasswordLength\\": 12,\\n \\"RequireLowercaseCharacters\\": true,\\n \\"RequireUppercaseCharacters\\": true,\\n \\"RequireNumbers\\": true,\\n \\"RequireSymbols\\": true\\n }\\n}"},{"type":"xml","example":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n false\\n 5\\n 0\\n 0\\n 12\\n true\\n true\\n true\\n true\\n \\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 12\\n true\\n true\\n true\\n true\\n \\n"}]',
'title' => '设置RAM用户密码强度等策略信息',
'summary' => '调用SetPasswordPolicy接口设置RAM用户密码强度等策略信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetPasswordPolicy' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '04F0F334-1335-436C-A1D7-6C044FE73368',
],
'PasswordPolicy' => [
'description' => '密码策略。',
'type' => 'object',
'properties' => [
'RequireNumbers' => [
'description' => '必须包含数字。',
'type' => 'boolean',
'example' => 'true',
],
'RequireLowercaseCharacters' => [
'description' => '必须包含小写字母。',
'type' => 'boolean',
'example' => 'true',
],
'HardExpiry' => [
'description' => '密码是否过期。'."\n"
.'取值为`true`或`false`,如果未指定此参数的值,系统默认为`false`。'."\n"
."\n"
.'- 如果取值为`true`,此时必须由主账号重置密码后,RAM用户才能正常登录。'."\n"
.'- 如果取值为`false`,此时RAM用户可以在密码过期后自行更改密码,并继续以用户身份登录。',
'type' => 'boolean',
'example' => 'false',
],
'PasswordReusePrevention' => [
'description' => '禁止使用前N次密码。0表示不启用历史密码检查策略,默认不启用。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'RequireSymbols' => [
'description' => '必须包含字符。',
'type' => 'boolean',
'example' => 'true',
],
'MaxPasswordAge' => [
'description' => '密码有效期,单位为天(重置密码将重置密码过期时间)。0表示不启用密码过期策略,默认不启用。',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
],
'MinimumPasswordLength' => [
'description' => '最小密码长度。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'RequireUppercaseCharacters' => [
'description' => '必须包含大写字母。',
'type' => 'boolean',
'example' => 'true',
],
'MaxLoginAttemps' => [
'description' => '一小时内使用错误密码尝试登录最大次数(重置密码可清除尝试登录计数)。',
'type' => 'integer',
'format' => 'int32',
'example' => '5',
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PasswordPolicy\\": {\\n \\"RequireNumbers\\": true,\\n \\"RequireLowercaseCharacters\\": true,\\n \\"HardExpiry\\": false,\\n \\"PasswordReusePrevention\\": 0,\\n \\"RequireSymbols\\": true,\\n \\"MaxPasswordAge\\": 0,\\n \\"MinimumPasswordLength\\": 12,\\n \\"RequireUppercaseCharacters\\": true,\\n \\"MaxLoginAttemps\\": 5\\n }\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"PasswordPolicy\\": {\\n \\"MinimumPasswordLength\\": 12,\\n \\"RequireLowercaseCharacters\\": true,\\n \\"RequireUppercaseCharacters\\": true,\\n \\"RequireNumbers\\": true,\\n \\"RequireSymbols\\": true\\n }\\n}"},{"type":"xml","example":"04F0F334-1335-436C-A1D7-6C044FE73368\\n\\n false\\n 5\\n 0\\n 0\\n 12\\n true\\n true\\n true\\n true\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n 12\\n true\\n true\\n true\\n true\\n \\n"}]',
'title' => '获取RAM用户密码强度等策略信息',
'summary' => '调用GetPasswordPolicy接口获取RAM用户密码强度等策略信息。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SetSecurityPreference' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'EnableSaveMFATicket',
'in' => 'query',
'schema' => [
'description' => '是否允许RAM用户在登录时保存多因素设备认证状态,有效期为7天。取值:'."\n"
.'- true:允许。'."\n"
.'- false(默认值):不允许。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'AllowUserToChangePassword',
'in' => 'query',
'schema' => [
'description' => '是否允许RAM用户自主管理密码。取值:'."\n"
.'- true(默认值):允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'AllowUserToManageAccessKeys',
'in' => 'query',
'schema' => [
'description' => '是否允许RAM用户自主管理访问密钥。取值:'."\n"
.'- true:允许。'."\n"
.'- false(默认值):不允许。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'AllowUserToManagePublicKeys',
'in' => 'query',
'schema' => [
'description' => '是否允许RAM用户自主管理公钥。取值:'."\n"
.'- true:允许。'."\n"
.'- false(默认值):不允许。'."\n"
."\n"
.'> 该参数仅在日本站有效。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'AllowUserToManageMFADevices',
'in' => 'query',
'schema' => [
'description' => '是否允许RAM用户自主管理多因素认证设备。取值:'."\n"
.'- true(默认值):允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'LoginSessionDuration',
'in' => 'query',
'schema' => [
'description' => 'RAM用户登录有效期。'."\n"
."\n"
.'取值范围:1~24。默认值:6。单位:小时。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '6',
],
],
[
'name' => 'LoginNetworkMasks',
'in' => 'query',
'schema' => [
'description' => '登录掩码。登录掩码决定哪些IP地址会受到登录控制台的影响,包括密码登录和单点登录(SSO),但使用访问密钥发起的API调用并不受影响。'."\n"
."\n"
.'- 如果指定掩码,RAM用户只能从指定的IP地址进行登录。'."\n"
.'- 如果不指定任何掩码,登录控制台功能将适用于整个网络。'."\n"
."\n"
.'当需要配置多个登录掩码时,请使用分号(;)来分隔,例如:192.168.0.0/16;10.0.0.0/8。'."\n"
."\n"
.'最多配置40个登录掩码,总长度最大512个字符。',
'type' => 'string',
'required' => false,
'example' => '10.0.0.0/8',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'SecurityPreference' => [
'description' => '安全首选项。',
'type' => 'object',
'properties' => [
'AccessKeyPreference' => [
'description' => '访问密钥首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageAccessKeys' => [
'description' => '是否允许RAM用户自主管理访问密钥。',
'type' => 'boolean',
'example' => 'false',
],
],
],
'MFAPreference' => [
'description' => '多因素认证首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageMFADevices' => [
'description' => '是否允许RAM用户自主管理多因素认证设备。',
'type' => 'boolean',
'example' => 'false',
],
],
],
'LoginProfilePreference' => [
'description' => '登录首选项。',
'type' => 'object',
'properties' => [
'EnableSaveMFATicket' => [
'description' => '是否允许RAM用户在登录时保存多因素认证设备安全码。',
'type' => 'boolean',
'example' => 'false',
],
'LoginSessionDuration' => [
'description' => 'RAM用户登录有效期。',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'LoginNetworkMasks' => [
'description' => '登录掩码。',
'type' => 'string',
'example' => '10.0.0.0/8',
],
'AllowUserToChangePassword' => [
'description' => '是否允许RAM用户自主管理密码。',
'type' => 'boolean',
'example' => 'true',
],
],
],
'PublicKeyPreference' => [
'description' => '公钥首选项。'."\n"
.'> 该参数仅在日本站有效。'."\n",
'type' => 'object',
'properties' => [
'AllowUserToManagePublicKeys' => [
'description' => '是否允许RAM用户自主管理公钥。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A978915D-F279-4CA0-A89B-9A71219FFB3E',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecurityPreference\\": {\\n \\"AccessKeyPreference\\": {\\n \\"AllowUserToManageAccessKeys\\": false\\n },\\n \\"MFAPreference\\": {\\n \\"AllowUserToManageMFADevices\\": false\\n },\\n \\"LoginProfilePreference\\": {\\n \\"EnableSaveMFATicket\\": false,\\n \\"LoginSessionDuration\\": 6,\\n \\"LoginNetworkMasks\\": \\"10.0.0.0/8\\",\\n \\"AllowUserToChangePassword\\": true\\n },\\n \\"PublicKeyPreference\\": {\\n \\"AllowUserToManagePublicKeys\\": false\\n }\\n },\\n \\"RequestId\\": \\"A978915D-F279-4CA0-A89B-9A71219FFB3E\\"\\n}","errorExample":"{\\n \\"RequestId\\": \\"04F0F334-1335-436C-A1D7-6C044FE73368\\",\\n \\"SecurityPreference\\": {\\n \\"LoginProfilePreference\\": {\\n \\"EnableSaveMFATicket\\": true,\\n \\"AllowUserToChangePassword\\": true\\n },\\n \\"AccessKeyPreference\\": {\\n \\"AllowUserToManageAccessKeys\\": false\\n },\\n \\"MFAPreference\\": {\\n \\"AllowUserToManageMFADevices\\": true\\n }\\n }\\n}"},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t6\\r\\n\\t\\t\\t\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tA978915D-F279-4CA0-A89B-9A71219FFB3E\\r\\n\\t\\r\\n","errorExample":"\\n 04F0F334-1335-436C-A1D7-6C044FE73368\\n \\n \\n true\\n true\\n LoginProfilePreference>\\n \\n false\\n \\n \\n false\\n \\n \\n"}]',
'title' => '设置全局安全首选项',
'summary' => '调用SetSecurityPreference接口设置全局安全首选项。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetSecurityPreference' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecurityPreference' => [
'description' => '安全首选项。',
'type' => 'object',
'properties' => [
'AccessKeyPreference' => [
'description' => '访问密钥首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageAccessKeys' => [
'description' => '是否允许用户自主管理访问密钥。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'example' => 'false',
],
],
],
'MFAPreference' => [
'description' => '多因素认证首选项。',
'type' => 'object',
'properties' => [
'AllowUserToManageMFADevices' => [
'description' => '是否允许RAM用户自主管理多因素认证设备。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'example' => 'true',
],
],
],
'LoginProfilePreference' => [
'description' => '登录首选项。',
'type' => 'object',
'properties' => [
'EnableSaveMFATicket' => [
'description' => '是否允许RAM用户登录时保存多因素认证设备安全码,安全码有效期为7天。取值:'."\n"
."\n"
.'- true:允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'example' => 'false',
],
'LoginSessionDuration' => [
'description' => 'RAM用户登录有效期。单位:小时。',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'LoginNetworkMasks' => [
'description' => '登录掩码。登录掩码决定哪些IP地址会受到登录控制台的影响,包括密码登录和SSO登录,但使用AccessKey发起的API访问并不受影响。'."\n"
."\n"
.'- 如果指定掩码,RAM用户只能从指定的IP地址进行登录。'."\n"
.'- 如果不指定任何掩码,登录控制台功能将适用于整个网络。'."\n"
."\n"
.'当需要配置多个登录掩码时,请使用分号(;)来分隔登录掩码,例如:192.168.0.0/16;10.0.0.0/8。',
'type' => 'string',
'example' => '10.0.0.0/8',
],
'AllowUserToChangePassword' => [
'description' => '是否允许RAM用户自主管理密码。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'example' => 'true',
],
],
],
'PublicKeyPreference' => [
'description' => '公钥首选项。'."\n"
."\n"
.'> 该参数仅在日本站有效。',
'type' => 'object',
'properties' => [
'AllowUserToManagePublicKeys' => [
'description' => '是否允许RAM用户自主管理公钥。取值:'."\n"
.'- true:允许。'."\n"
.'- false:不允许。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DC1213F1-A9D5-4A01-A996-44983689126C',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecurityPreference\\": {\\n \\"AccessKeyPreference\\": {\\n \\"AllowUserToManageAccessKeys\\": false\\n },\\n \\"MFAPreference\\": {\\n \\"AllowUserToManageMFADevices\\": true\\n },\\n \\"LoginProfilePreference\\": {\\n \\"EnableSaveMFATicket\\": false,\\n \\"LoginSessionDuration\\": 6,\\n \\"LoginNetworkMasks\\": \\"10.0.0.0/8\\",\\n \\"AllowUserToChangePassword\\": true\\n },\\n \\"PublicKeyPreference\\": {\\n \\"AllowUserToManagePublicKeys\\": false\\n }\\n },\\n \\"RequestId\\": \\"DC1213F1-A9D5-4A01-A996-44983689126C\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t6\\r\\n\\t\\t\\t\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tDC1213F1-A9D5-4A01-A996-44983689126C\\r\\n\\r\\n\\t\\r\\n","errorExample":""}]',
'title' => '获取全局安全首选项详情',
'summary' => '调用GetSecurityPreference接口获取全局安全首选项详情。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DecodeDiagnosticMessage' => [
'summary' => '从因无RAM权限导致的请求被拒绝访问的响应体中解码无权限诊断信息。',
'methods' => [
'get',
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'EncodedDiagnosticMessage',
'in' => 'query',
'schema' => [
'description' => 'API请求因无权限被拒绝访问时,请求响应体中返回的编码的诊断信息。',
'type' => 'string',
'required' => false,
'example' => 'AQEAAAAAZBgxr0U1MjA1NTM1LUM4BBktMzE5RS1CODgxLUU1QTI0RDNFQTM1****',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'D2331703-AADF-5564-BA9B-26CD51A33BA0',
],
'DecodedDiagnosticMessage' => [
'description' => '解码的诊断信息。',
'type' => 'object',
'properties' => [
'ExplicitDeny' => [
'description' => '是否是显式拒绝。',
'type' => 'boolean',
'enumValueTitles' => [
'true' => '是显示拒绝',
'false' => '不是显示拒绝',
],
'example' => 'true',
],
'NoPermissionPolicyType' => [
'description' => '产生无权限的策略类型。',
'type' => 'string',
'enumValueTitles' => [
'AssumeRolePolicy' => '角色信任策略',
'ControlPolicy' => '管控策略',
'AccountLevelIdentityBasedPolicy' => '基于身份策略(账号级)',
'ResourceGroupLevelIdentityBasedPolicy' => '基于身份策略(资源组级)',
'SessionPolicy' => '会话策略',
],
'example' => 'AccountLevelIdentityBasedPolicy',
],
'AuthAction' => [
'description' => '用户请求中用于鉴权的操作信息。',
'type' => 'string',
'example' => 'ram:DecodeDiagnosticMessage',
],
'AuthResource' => [
'description' => '用户请求中用于鉴权的资源信息。',
'type' => 'string',
'example' => '*',
],
'AuthPrincipal' => [
'description' => '用户请求中用于鉴权的主体信息。',
'type' => 'object',
'properties' => [
'AuthPrincipalType' => [
'description' => '用户请求中用于鉴权的身份类型。',
'type' => 'string',
'enumValueTitles' => [
'SubUser' => 'RAM用户',
'AssumedRoleUser' => 'RAM角色',
'Federated' => 'SSO联合身份',
],
'example' => 'SubUser',
],
'AuthPrincipalOwnerId' => [
'description' => '用户请求中用于鉴权的身份所属的阿里云账号UID信息。',
'type' => 'string',
'example' => '196813200012****',
],
'AuthPrincipalDisplayName' => [
'description' => '用户请求中用于鉴权的身份标识。具体如下:'."\n"
."\n"
.'- RAM用户:提供的是RAM用户的UID信息。'."\n"
.'- RAM角色:提供的是角色名称和角色会话名称(例如:RoleName:RoleSessionName)。'."\n"
.'- SSO联合身份:提供的是身份提供商类型和身份提供商名称(例如:saml-provider/AzureAD)。',
'type' => 'string',
'example' => '28877424437521****',
],
],
],
'AuthConditions' => [
'description' => '用户请求中用于鉴权的条件列表。',
'type' => 'array',
'items' => [
'description' => '鉴权条件。',
'type' => 'object',
'properties' => [
'ConditionKey' => [
'description' => '鉴权条件Key。',
'type' => 'string',
'example' => 'acs:SourceIp',
],
'ConditionValues' => [
'description' => '鉴权条件Key对应的值列表。',
'type' => 'array',
'items' => [
'description' => '鉴权条件Key对应的条件值。',
'type' => 'string',
'example' => '172.16.215.218',
],
],
],
],
],
'MatchedPolicies' => [
'description' => '鉴权命中的策略列表。',
'type' => 'array',
'items' => [
'description' => '鉴权命中的策略。',
'type' => 'object',
'properties' => [
'Effect' => [
'description' => '策略效果。',
'type' => 'string',
'enumValueTitles' => [
'Deny' => '拒绝',
'Allow' => '允许',
],
'example' => 'Deny',
],
'PolicyIdentifier' => [
'description' => '策略名称信息。具体如下:'."\n"
.'- 管控策略:管控策略ID。'."\n"
.'- RAM权限策略:权限策略名称。',
'type' => 'string',
'example' => 'MyPolicyName',
],
'PolicyType' => [
'description' => '策略类型。',
'type' => 'string',
'enumValueTitles' => [
'Custom' => '自定义策略',
'System' => '系统策略',
],
'example' => 'Custom',
],
'PolicyVersion' => [
'description' => '策略版本号。'."\n"
.'> 仅自定义策略有版本号。',
'type' => 'string',
'example' => 'v1',
],
'AttachedEntityType' => [
'description' => '策略授权的实体类型。',
'type' => 'string',
'enumValueTitles' => [
'RamUser' => 'RAM用户',
'RamRole' => 'RAM角色',
'ResourceDirectoryTarget' => '资源目录实体',
'RamGroup' => 'RAM用户组',
],
'example' => 'RamUser',
],
'AttachedScope' => [
'description' => '策略授权范围。',
'type' => 'string',
'enumValueTitles' => [
'Account' => '阿里云账号',
'Folder' => '资源目录资源夹',
'ResourceGroup' => '资源组',
],
'example' => 'Account',
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NotSupport',
'errorMessage' => 'This method can only be invoked by customer, sub user and assumed role user.',
],
[
'errorCode' => 'EncodedMessageExpire',
'errorMessage' => 'The EncodedDiagnosticMessage is expired.',
],
],
403 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You do not have the required permissions.',
],
],
[
[
'errorCode' => 'SearchInaccurate',
'errorMessage' => 'The search result is inaccurate, please retry later.',
],
[
'errorCode' => 'EntityNotExist',
'errorMessage' => 'The specific DecodedDiagnosticMessage cannot be found.',
],
],
429 => [
[
'errorCode' => 'TooManyRequests',
'errorMessage' => 'Too many search requests at same time, please retry later.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D2331703-AADF-5564-BA9B-26CD51A33BA0\\",\\n \\"DecodedDiagnosticMessage\\": {\\n \\"ExplicitDeny\\": true,\\n \\"NoPermissionPolicyType\\": \\"AccountLevelIdentityBasedPolicy\\",\\n \\"AuthAction\\": \\"ram:DecodeDiagnosticMessage\\",\\n \\"AuthResource\\": \\"*\\",\\n \\"AuthPrincipal\\": {\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"AuthPrincipalOwnerId\\": \\"196813200012****\\",\\n \\"AuthPrincipalDisplayName\\": \\"28877424437521****\\"\\n },\\n \\"AuthConditions\\": [\\n {\\n \\"ConditionKey\\": \\"acs:SourceIp\\",\\n \\"ConditionValues\\": [\\n \\"172.16.215.218\\"\\n ]\\n }\\n ],\\n \\"MatchedPolicies\\": [\\n {\\n \\"Effect\\": \\"Deny\\",\\n \\"PolicyIdentifier\\": \\"MyPolicyName\\",\\n \\"PolicyType\\": \\"Custom\\",\\n \\"PolicyVersion\\": \\"v1\\",\\n \\"AttachedEntityType\\": \\"RamUser\\",\\n \\"AttachedScope\\": \\"Account\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '解码无权限诊断信息',
],
'TagResources' => [
'summary' => '调用TagResources为云资源(RAM角色、权限策略)创建并绑定标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '254511',
'abilityTreeNodes' => [
'FEATUREramGR28GE',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'role' => 'RAM角色',
'policy' => '权限策略',
],
'example' => 'role',
],
],
[
'name' => 'ResourceNames',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '资源名称列表,一次最多支持输入50个资源名称。',
'type' => 'array',
'items' => [
'description' => '资源名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'role1',
],
'required' => false,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签列表。一次最多支持输入20个标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。最多支持128个字符。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'k1',
],
'Value' => [
'description' => '标签值。最多支持256个字符。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'v1',
],
],
'required' => true,
'docRequired' => true,
],
'required' => true,
'docRequired' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '697852FB-50D7-44D9-9774-530C31EAC572',
],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"697852FB-50D7-44D9-9774-530C31EAC572\\"\\n}","type":"json"}]',
'title' => '为云资源创建并绑定标签',
],
'UntagResources' => [
'summary' => '调用UntagResources为云资源(RAM角色、权限策略)解绑标签。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '255085',
'abilityTreeNodes' => [
'FEATUREramGR28GE',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'role' => 'RAM角色',
'policy' => '权限策略',
],
'example' => 'role',
],
],
[
'name' => 'ResourceNames',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '资源名称列表,一次最多支持输入50个资源名称。',
'type' => 'array',
'items' => [
'description' => '资源名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'role1',
],
'required' => true,
'docRequired' => true,
],
],
[
'name' => 'TagKeys',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '资源的标签键列表。一次最多支持输入20个标签键。',
'type' => 'array',
'items' => [
'description' => '标签键。最多支持128个字符。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 't1',
],
'required' => false,
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'description' => '是否解绑资源上的全部标签。',
'type' => 'boolean',
'required' => false,
'docRequired' => false,
'enumValueTitles' => [
'true' => '解绑全部标签',
'false' => '不解绑全部标签',
],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '9B34724D-54B0-4A51-B34D-4512372FE1BE',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B34724D-54B0-4A51-B34D-4512372FE1BE\\"\\n}","type":"json"}]',
'title' => '为云资源解绑标签',
],
'ListTagResources' => [
'summary' => '查询云资源(RAM角色、权限策略)绑定的标签列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '255081',
'abilityTreeNodes' => [
'FEATUREramGR28GE',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => [
'role' => 'RAM角色',
'policy' => '权限策略',
],
'example' => 'role',
],
],
[
'name' => 'ResourceNames',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '资源名称列表,一次最多支持输入50个资源名称。',
'type' => 'array',
'items' => [
'description' => '资源名称。',
'type' => 'string',
'required' => false,
'example' => 'role1',
],
'required' => false,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签列表。一次最多支持输入20个标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。最多支持128个字符。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 't1',
],
'Value' => [
'description' => '标签值。最多支持256个字符。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'v1',
],
],
'required' => false,
'docRequired' => false,
],
'required' => false,
'docRequired' => false,
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'example' => '100',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '下一页查询开始的Token。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'GY/oWREsOP1bPHGcHGrXfYX7UG1k9KqWFYThNDPx1UX26PbWOIu2CMqqiMr68H/K',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => '5CCE804C-6450-49A7-B1DB-2460F7A97416',
],
'TagResources' => [
'description' => '云资源绑定的标签列表。',
'type' => 'array',
'items' => [
'description' => '云资源绑定的标签。',
'type' => 'object',
'properties' => [
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'role1',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'enumValueTitles' => [
'role' => 'RAM角色',
'policy' => '权限策略',
],
'example' => 'role',
],
'TagKey' => [
'description' => '标签键。',
'type' => 'string',
'example' => 't1',
],
'TagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'v1',
],
],
],
],
'NextToken' => [
'description' => '下一页查询开始的Token。',
'type' => 'string',
'example' => 'GY/oWREsOP1bPHGcHGrXfYX7UG1k9KqWFYThNDPx1UX26PbWOIu2CMqqiMr68H/K',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5CCE804C-6450-49A7-B1DB-2460F7A97416\\",\\n \\"TagResources\\": [\\n {\\n \\"ResourceName\\": \\"role1\\",\\n \\"ResourceType\\": \\"role\\",\\n \\"TagKey\\": \\"t1\\",\\n \\"TagValue\\": \\"v1\\"\\n }\\n ],\\n \\"NextToken\\": \\"GY/oWREsOP1bPHGcHGrXfYX7UG1k9KqWFYThNDPx1UX26PbWOIu2CMqqiMr68H/K\\"\\n}","type":"json"}]',
'title' => '查询云资源的标签列表',
],
],
'endpoints' => [
[
'regionId' => 'ap-northeast-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-3',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-5',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-beijing',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-chengdu',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-hongkong',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-huhehaote',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-qingdao',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-zhangjiakou',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'us-west-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'us-east-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'eu-west-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'eu-central-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'me-east-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-shenzhen-finance-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-shanghai-finance-1',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-hangzhou-finance',
'endpoint' => 'ram.aliyuncs.com',
],
[
'regionId' => 'cn-beijing-finance-1',
'endpoint' => 'ram.aliyuncs.com',
],
],
];