Call GetDomain to get domain information - Drive and Photo Service - Alibaba Cloud - Drive and Photo Service

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST /v2/domain/get HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
domain_id	string	Yes	The ID of the domain.	bj1
get_quota_used	boolean	No	Specifies whether to return the used quota of the domain. Default value: false. If the quota of the domain is greater than 0 and you set this parameter to true, the used quota of the domain is returned.	true
fields	string	No	The domain property fields to obtain, separated by commas. An empty value indicates that no enumeration fields are obtained.	file_category

Response elements

Element	Type	Description	Example
	Domain	The information about the domain.

Examples

Success response

JSON format

{
  "parent_domain_id": "bj1",
  "domain_id": "bj2",
  "domain_name": "pdsdomain",
  "description": "my domain",
  "init_drive_enable": true,
  "init_drive_size": 1073741824,
  "updated_at": "2019-08-20T06:51:27.292Z",
  "created_at": "2019-08-20T06:51:27.292Z",
  "size_quota": 1099511627776,
  "size_quota_used": 1099511627776,
  "user_count_quota": 50,
  "status": 1,
  "used_size": 1099511627776,
  "published_app_access_strategy": {
    "effect": "deny",
    "except_app_id_list": [
      "8ovxCTRUDdbpVWBP"
    ]
  },
  "sharable": false,
  "data_hash_name": "sha1",
  "store_redundancy_type": "LRS"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.